Pools - List Pool Node Counts

Serviço:: Batch Service

Versão da API:: 2025-06-01

Obtém o número de nós de computação em cada estado, agrupados por pool. Observe que os números retornados podem nem sempre estar atualizados. Se precisar de contagens exatas de nós, use uma consulta de lista.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	Ponto de extremidade da conta em lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
$filter	query		string	Uma cláusula $filter OData. Para mais informações sobre como construir este filtro, veja https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	O número máximo de itens a serem retornados na resposta. Podem ser devolvidos um máximo de 1000 candidaturas.
timeOut	query		integer (int32)	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for superior a 30, será usado o padrão em vez disso.".

Cabeçalho do Pedido

Name	Tipo	Description
client-request-id	string	A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Se o servidor deve retornar o client-request-id na resposta.
ocp-date	string (date-time-rfc7231)	A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Name	Tipo	Description
200 OK	BatchPoolNodeCountsListResult	O pedido foi bem-sucedido. Cabeçalhos ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Uma resposta de erro inesperada.

Name

Tipo

Description

200 OK

BatchPoolNodeCountsListResult

O pedido foi bem-sucedido.

Cabeçalhos

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

Other Status Codes

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

Name	Description
https://batch.core.windows.net//.default

Exemplos

NodeCountsPayload

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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
      }
    }
  ]
}

Definições

Name	Description
BatchError	Uma resposta de erro recebida do serviço Batch do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
BatchErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
BatchNodeCounts	O número de nós de computação em cada estado de nó de computação.
BatchPoolNodeCounts	O número de nós de computação em cada estado para um pool.
BatchPoolNodeCountsListResult	O resultado da listagem do Nó de Computação conta na Conta.

BatchError

Object

Uma resposta de erro recebida do serviço Batch do Azure.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	BatchErrorMessage	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Object

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
value	string	As informações adicionais incluídas com a resposta de erro.

BatchErrorMessage

Object

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Name	Tipo	Description
lang	string	O código da linguagem da mensagem de erro.
value	string	O texto da mensagem.

BatchNodeCounts

Object

O número de nós de computação em cada estado de nó de computação.

Name	Tipo	Description
creating	integer (int32)	O número de Nós de Computação no estado de criação.
deallocated	integer (int32)	O número de Nós de Computação no estado desalocado.
deallocating	integer (int32)	O número de Nós de Computação no estado de desalocação.
idle	integer (int32)	O número de Nós de Computação em estado inativo.
leavingPool	integer (int32)	O número de Nós de Computação no estado leavevingPool.
offline	integer (int32)	O número de Nós de Computação no estado offline.
preempted	integer (int32)	O número de Nós de Computação no estado preemptado.
rebooting	integer (int32)	A contagem de Nós de Computação no estado de reinicio.
reimaging	integer (int32)	O número de Nós de Computação no estado de reimageamento.
running	integer (int32)	O número de Nós de Computação no estado de execução.
startTaskFailed	integer (int32)	O número de Nós de Computação no estado startTaskFail.
starting	integer (int32)	O número de Nós de Computação no estado inicial.
total	integer (int32)	O número total de Nós de Computação.
unknown	integer (int32)	O número de Nós de Computação no estado desconhecido.
unusable	integer (int32)	O número de Nós de Computação no estado inutilizável.
upgradingOS	integer (int32)	O número de Nós de Computação no estado de atualizaçãoOS.
waitingForStartTask	integer (int32)	O número de Nós de Computação no estado waitingForStartTask.

BatchPoolNodeCounts

Object

O número de nós de computação em cada estado para um pool.

Name	Tipo	Description
dedicated	BatchNodeCounts	O número de Nós de Computação dedicados em cada estado.
lowPriority	BatchNodeCounts	O número de Nós de Computação Spot/Baixa Prioridade em cada estado.
poolId	string	O ID da piscina.

BatchPoolNodeCountsListResult

Object

O resultado da listagem do Nó de Computação conta na Conta.

Name	Tipo	Description
odata.nextLink	string (uri)	O URL para obter o próximo conjunto de resultados.
value	BatchPoolNodeCounts[]	Uma lista de contagens de Nós de Computação por Pool.

Partilhar via

Pools - List Pool Node Counts

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

OAuth2Auth

Âmbitos

Exemplos

NodeCountsPayload

Pedido de amostra

Resposta da amostra

Definições

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeCounts

BatchPoolNodeCounts

BatchPoolNodeCountsListResult