Account - List Pool Node Counts

Riferimento

Service:: Batch Service

API Version:: 2023-11-01.18.0

Ottiene il numero di nodi di calcolo in ogni stato, raggruppati in base al pool. Si noti che i numeri restituiti potrebbero non essere sempre aggiornati. Se sono necessari conteggi di nodi esatti, usare una query di elenco.

GET {batchUrl}/nodecounts?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/nodecounts?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste di servizio Azure Batch.
api-version	query	True	string	Versione dell'API client.
$filter	query		string	Clausola OData $filter. Per altre informazioni sulla costruzione di questo filtro, vedere https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer int32	Numero massimo di elementi da restituire nella risposta.
timeout	query		integer int32	Tempo massimo per cui il server può trascorrere l'elaborazione della richiesta, in secondi. Il valore predefinito è 30 secondi.

Intestazione della richiesta

Media Types: "application/json; odata=minimalmetadata"

Nome	Tipo	Descrizione
client-request-id	string uuid	Identità richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50E-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Se il server deve restituire l'ID richiesta client nella risposta.
ocp-date	string date-time-rfc1123	Ora in cui è stata eseguita la richiesta. Le librerie client in genere impostano l'ora dell'orologio del sistema corrente; impostarla in modo esplicito se si chiama direttamente l'API REST.

Risposte

Nome	Tipo	Descrizione
200 OK	PoolNodeCountsListResult	La risposta contiene il numero di nodi di calcolo in ogni stato del nodo di calcolo, raggruppati in base al pool. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Errore dal servizio Batch.

Nome

Tipo

Descrizione

200 OK

PoolNodeCountsListResult

La risposta contiene il numero di nodi di calcolo in ogni stato del nodo di calcolo, raggruppati in base al pool.

Headers

client-request-id: string
request-id: string

Other Status Codes

BatchError

Errore dal servizio Batch.

Sicurezza

azure_auth

Microsoft Entra flusso di codice di autenticazione OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Type: apiKey
In: header

Esempio

NodeCountsPayload

Sample Request

HTTP

GET account.region.batch.azure.com/nodecounts?api-version=2023-11-01.18.0

Sample Response

Status code:: 200

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 0
      },
      "lowPriority": {
        "creating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 2,
        "starting": 1,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 0,
        "idle": 1,
        "leavingPool": 0,
        "offline": 3,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 4
      },
      "lowPriority": {
        "creating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 0,
        "idle": 5,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 4,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 11
      }
    }
  ]
}

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore Azure Batch.
NodeCounts	Numero di nodi di calcolo in ogni stato del nodo di calcolo.
PoolNodeCounts	Numero di nodi di calcolo in ogni stato per un pool.
PoolNodeCountsListResult	Risultato dell'elenco dei conteggi dei nodi di calcolo nell'account.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.
message	ErrorMessage	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	BatchErrorDetail[]	Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta all'errore.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore Azure Batch.

Nome	Tipo	Descrizione
lang	string	Codice del linguaggio del messaggio di errore
value	string	Testo del messaggio.

NodeCounts

Numero di nodi di calcolo in ogni stato del nodo di calcolo.

Nome	Tipo	Descrizione
creating	integer	Numero di nodi di calcolo nello stato di creazione.
idle	integer	Numero di nodi di calcolo nello stato di inattività.
leavingPool	integer	Numero di nodi di calcolo nello stato di leavingPool.
offline	integer	Numero di nodi di calcolo nello stato offline.
preempted	integer	Numero di nodi di calcolo nello stato preempted.
rebooting	integer	Numero di nodi di calcolo nello stato di riavvio.
reimaging	integer	Numero di nodi di calcolo nello stato di ripetizione.
running	integer	Numero di nodi di calcolo nello stato in esecuzione.
startTaskFailed	integer	Numero di nodi di calcolo nello stato startTaskFailed.
starting	integer	Numero di nodi di calcolo nello stato iniziale.
total	integer	Numero totale di nodi di calcolo.
unknown	integer	Numero di nodi di calcolo nello stato sconosciuto.
unusable	integer	Numero di nodi di calcolo nello stato inutilizzabile.
waitingForStartTask	integer	Numero di nodi di calcolo nello stato in attesaForStartTask.

PoolNodeCounts

Numero di nodi di calcolo in ogni stato per un pool.

Nome	Tipo	Descrizione
dedicated	NodeCounts	Numero di nodi di calcolo dedicati in ogni stato.
lowPriority	NodeCounts	Numero di nodi di calcolo con priorità spot/bassa in ogni stato.
poolId	string	ID del pool.

PoolNodeCountsListResult

Risultato dell'elenco dei conteggi dei nodi di calcolo nell'account.

Nome	Tipo	Descrizione
odata.nextLink	string	URL per ottenere il set successivo di risultati.
value	PoolNodeCounts[]	Elenco dei conteggi dei nodi di calcolo in base al pool.

Share via

Account - List Pool Node Counts

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Authorization

Esempio

NodeCountsPayload

Sample Request

Sample Response

Definizioni

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Risorse aggiuntive