Account - List Pool Node Counts

Referência

Serviço:: Batch Service

Versão da API:: 2024-07-01.20.0

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 você precisar de contagens exatas de nó, use uma consulta de lista.

GET {batchUrl}/nodecounts?api-version=2024-07-01.20.0

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço do Lote do Azure.
api-version	query	True	string	Versão da API do cliente.
$filter	query		string	Uma cláusula $filter OData. Para obter mais informações sobre como construir esse filtro, consulte https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer int32	O número máximo de itens a serem retornados na resposta.
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 maior que 30, o padrão será usado.

Cabeçalho da solicitação

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

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

Respostas

Nome	Tipo	Description
200 OK	PoolNodeCountsListResult	A resposta contém o número de nós de computação em cada estado do Nó de Computação, agrupados por pool. Cabeçalhos client-request-id: string request-id: string
Other Status Codes	BatchError	O erro do serviço do Lote.

Nome

Tipo

Description

200 OK

PoolNodeCountsListResult

A resposta contém o número de nós de computação em cada estado do Nó de Computação, agrupados por pool.

Cabeçalhos

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

Other Status Codes

BatchError

O erro do serviço do Lote.

Segurança

azure_auth

Fluxo de código de autenticação do Microsoft Entra OAuth 2.0

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

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Tipo: apiKey
Em: header

Exemplos

NodeCountsPayload

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Nome	Description
BatchError	Uma resposta de erro recebida do serviço do Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
NodeCounts	O número de nós de computação em cada estado do Nó de Computação.
PoolNodeCounts	O número de nós de computação em cada estado para um pool.
PoolNodeCountsListResult	O resultado da listagem das contagens do Nó de Computação na Conta.

BatchError

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

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve 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

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

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

ErrorMessage

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

Nome	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.

NodeCounts

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

Nome	Tipo	Description
creating	integer	O número de nós de computação no estado de criação.
deallocated	integer	O número de nós de computação no estado desalocado.
deallocating	integer	O número de nós de computação no estado desalocado.
idle	integer	O número de nós de computação no estado ocioso.
leavingPool	integer	O número de nós de computação no estado leavingPool.
offline	integer	O número de nós de computação no estado offline.
preempted	integer	O número de nós de computação no estado preempível.
rebooting	integer	A contagem de nós de computação no estado de reinicialização.
reimaging	integer	O número de nós de computação no estado de reimaginação.
running	integer	O número de nós de computação no estado em execução.
startTaskFailed	integer	O número de nós de computação no estado startTaskFailed.
starting	integer	O número de nós de computação no estado inicial.
total	integer	O número total de nós de computação.
unknown	integer	O número de nós de computação no estado desconhecido.
unusable	integer	O número de nós de computação no estado inutilizável.
upgradingOS	integer	O número de nós de computação no estado de atualização do OS.
waitingForStartTask	integer	O número de nós de computação no estado waitingForStartTask.

PoolNodeCounts

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

Nome	Tipo	Description
dedicated	NodeCounts	O número de nós de computação dedicados em cada estado.
lowPriority	NodeCounts	O número de nós de computação spot/de baixa prioridade em cada estado.
poolId	string	A ID do pool.

PoolNodeCountsListResult

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

Nome	Tipo	Description
odata.nextLink	string	A URL para obter o próximo conjunto de resultados.
value	PoolNodeCounts[]	Uma lista de contagens de nós de computação por pool.

Compartilhar via

Account - List Pool Node Counts

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

azure_auth

Escopos

Authorization

Exemplos

NodeCountsPayload

Solicitação de exemplo

Resposta de exemplo

Definições

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Recursos adicionais