Account - List Pool Node Counts

Riferimento

Servizio:: Batch Service

Versione API:: 2024-07-01.20.0

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 {batchUrl}/nodecounts?api-version=2024-07-01.20.0

Con parametri facoltativi:

GET {batchUrl}/nodecounts?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste del servizio Azure Batch.
api-version	query	True	string	Versione dell'API client.
$filter	query		string	Clausola di $filter OData. Per altre informazioni sulla creazione di questo filtro, vedere https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer (int32) minimum: 1 maximum: 10	Numero massimo di elementi da restituire nella risposta.
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 è maggiore di 30, verrà usato il valore predefinito.

Intestazione della richiesta

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

Nome	Tipo	Descrizione
client-request-id	string (uuid)	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-rfc1123)	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	PoolNodeCountsListResult	La risposta contiene il numero di nodi di calcolo in ogni stato del nodo di calcolo, raggruppati per pool. Intestazioni client-request-id: string request-id: string
Other Status Codes	BatchError	Errore del 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 per pool.

Intestazioni

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

Other Status Codes

BatchError

Errore del servizio Batch.

Sicurezza

azure_auth

Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0

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

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Tipo: apiKey
In: header

Esempio

NodeCountsPayload

Esempio di richiesta

HTTP

GET account.region.batch.azure.com/nodecounts?api-version=2024-07-01.20.0

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.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore di 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

Object

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	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

Object

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.

ErrorMessage

Object

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

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

NodeCounts

Object

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

Nome	Tipo	Descrizione
creating	integer (int32)	Numero di nodi di calcolo nello stato di creazione.
deallocated	integer (int32)	Numero di nodi di calcolo nello stato deallocato.
deallocating	integer (int32)	Numero di nodi di calcolo nello stato di deallocazione.
idle	integer (int32)	Numero di nodi di calcolo nello stato di inattività.
leavingPool	integer (int32)	Numero di nodi di calcolo nello stato leavingPool.
offline	integer (int32)	Numero di nodi di calcolo nello stato offline.
preempted	integer (int32)	Numero di nodi di calcolo nello stato non superato.
rebooting	integer (int32)	Conteggio dei nodi di calcolo nello stato di riavvio.
reimaging	integer (int32)	Numero di nodi di calcolo nello stato di ripetizione dell'immagini.
running	integer (int32)	Numero di nodi di calcolo nello stato di esecuzione.
startTaskFailed	integer (int32)	Numero di nodi di calcolo nello stato startTaskFailed.
starting	integer (int32)	Numero di nodi di calcolo nello stato iniziale.
total	integer (int32)	Numero totale di nodi di calcolo.
unknown	integer (int32)	Numero di nodi di calcolo nello stato sconosciuto.
unusable	integer (int32)	Numero di nodi di calcolo nello stato inutilizzabile.
upgradingOS	integer (int32)	Numero di nodi di calcolo nello stato upgradeOS.
waitingForStartTask	integer (int32)	Numero di nodi di calcolo nello stato waitingForStartTask.

PoolNodeCounts

Object

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 spot/con priorità bassa in ogni stato.
poolId	string	ID del pool.

PoolNodeCountsListResult

Object

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

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

Condividi tramite

Account - List Pool Node Counts

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Authorization

Esempio

NodeCountsPayload

Esempio di richiesta

Risposta di esempio

Definizioni

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Risorse aggiuntive