Pools - List Pool Node Counts

Servizio:: Batch Service

Versione API:: 2025-06-01

Ottiene il numero di nodi di calcolo in ogni stato, raggruppati per 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 {endpoint}/nodecounts?api-version=2025-06-01

Con parametri facoltativi:

GET {endpoint}/nodecounts?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	Endpoint dell'account Batch (ad esempio: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
$filter	query		string	Clausola di $filter OData. Per maggiori informazioni sulla costruzione di questo filtro, vedi https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Numero massimo di elementi da restituire nella risposta. Possono essere restituite un massimo di 1000 domande.
timeOut	query		integer (int32)	Tempo massimo di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è superiore a 30, verrà utilizzato il valore predefinito.".

Intestazione della richiesta

Nome	Tipo	Descrizione
client-request-id	string	Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Indica se il server deve restituire l'ID richiesta client nella risposta.
ocp-date	string (date-time-rfc7231)	Ora di emissione della richiesta. Le librerie client in genere impostano questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.

Risposte

Nome	Tipo	Descrizione
200 OK	BatchPoolNodeCountsListResult	La richiesta ha avuto esito positivo. Intestazioni ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Risposta di errore imprevista.

Nome

Tipo

Descrizione

200 OK

BatchPoolNodeCountsListResult

La richiesta ha avuto esito positivo.

Intestazioni

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
https://batch.core.windows.net//.default

Esempio

NodeCountsPayload

Esempio di richiesta

HTTP

GET {endpoint}/nodecounts?api-version=2025-06-01

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 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,
        "upgradingOS": 0,
        "total": 0
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 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,
        "upgradingOS": 0,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 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,
        "upgradingOS": 0,
        "total": 4
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 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,
        "upgradingOS": 0,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 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,
        "upgradingOS": 0,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 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 di Azure Batch.
BatchErrorMessage	Messaggio di errore ricevuto in una risposta di errore di Azure Batch.
BatchNodeCounts	Numero di nodi di calcolo in ogni stato del nodo di calcolo.
BatchPoolNodeCounts	Numero di nodi di calcolo in ogni stato per un pool.
BatchPoolNodeCountsListResult	Risultato dell'elenco dei conteggi dei nodi di calcolo nell'account.

BatchError

Oggetto

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message	BatchErrorMessage	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

Oggetto

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

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

BatchErrorMessage

Oggetto

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

Nome	Tipo	Descrizione
lang	string	Il codice linguistico del messaggio di errore.
value	string	Testo del messaggio.

BatchNodeCounts

Oggetto

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

Nome	Tipo	Descrizione
creating	integer (int32)	Il numero di nodi di calcolo nello stato di creazione.
deallocated	integer (int32)	Il numero di Nodi di Calcolo nello stato dealllocato.
deallocating	integer (int32)	Il numero di Nodi di Calcolo nello stato di deallocazione.
idle	integer (int32)	Il numero di Nodi di Calcolo in stato di inattività.
leavingPool	integer (int32)	Il numero di Nodi di Calcolo nello stato di LeavevingPool.
offline	integer (int32)	Il numero di nodi di calcolo nello stato offline.
preempted	integer (int32)	Il numero di Nodi di Calcolo nello stato preempted.
rebooting	integer (int32)	Il numero di Nodi di Calcolo nello stato di riavvio.
reimaging	integer (int32)	Il numero di nodi di calcolo nello stato di riimaginazione.
running	integer (int32)	Il numero di nodi di calcolo nello stato di esecuzione.
startTaskFailed	integer (int32)	Il numero di Nodi di Calcolo nello stato startTaskFail.
starting	integer (int32)	Il numero di nodi di calcolo nello stato iniziale.
total	integer (int32)	Il numero totale di nodi di calcolo.
unknown	integer (int32)	Il numero di Nodi di Calcolo nello stato sconosciuto.
unusable	integer (int32)	Il numero di Nodi di Calcolo nello stato inutilizzabile.
upgradingOS	integer (int32)	Il numero di nodi di calcolo nello stato di upgradeOS.
waitingForStartTask	integer (int32)	Il numero di Nodi di Calcolo nello stato in attesaForInizioTask.

BatchPoolNodeCounts

Oggetto

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

Nome	Tipo	Descrizione
dedicated	BatchNodeCounts	Il numero di nodi di calcolo dedicati in ogni stato.
lowPriority	BatchNodeCounts	Il numero di nodi di calcolo Spot/Bassa priorità in ogni stato.
poolId	string	L'ID della piscina.

BatchPoolNodeCountsListResult

Oggetto

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

Nome	Tipo	Descrizione
odata.nextLink	string (uri)	L'URL per ottenere il set di risultati successivo.
value	BatchPoolNodeCounts[]	Un elenco dei conteggi dei nodi di calcolo per pool.

Condividi tramite

Pools - List Pool Node Counts

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

OAuth2Auth

Ambiti

Esempio

NodeCountsPayload

Esempio di richiesta

Risposta di esempio

Definizioni

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeCounts

BatchPoolNodeCounts

BatchPoolNodeCountsListResult