Account - List Pool Node Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Obtém o número de Nós de Computação em cada estado, agrupados por Conjunto. Tenha em atenção que os números devolvidos podem nem sempre estar atualizados. Se precisar de contagens exatas de nós, utilize uma consulta de lista.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	O URL base para todos os pedidos de serviço Azure Batch.
api-version	query	True	string	Versão da API de Cliente.
$filter	query		string	Uma cláusula OData $filter. Para obter mais informações sobre como construir este filtro, consulte https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer int32	O número máximo de itens a devolver na resposta.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve devolver o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente.

Respostas

Name	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 Conjunto. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	O erro do serviço Batch.

Segurança

azure_auth

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

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

Scopes

Name	Description
user_impersonation	Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

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

Definições

Name	Description
BatchError	Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail	Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.
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 de um Conjunto.
PoolNodeCountsListResult	O resultado da listagem das contagens de Nós de Computação na Conta.

BatchError

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

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

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

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

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

Name	Tipo	Description
creating	integer	O número de Nós de Computação no estado de criação.
idle	integer	O número de Nós de Computação no estado inativo.
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 preempido.
rebooting	integer	A contagem de Nós de Computação no estado de reinício.
reimaging	integer	O número de Nós de Computação no estado de recriaçã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.
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 de um Conjunto.

Name	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/Baixa Prioridade em cada estado.
poolId	string	O ID do Conjunto.

PoolNodeCountsListResult

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

Name	Tipo	Description
odata.nextLink	string	O URL para obter o próximo conjunto de resultados.
value	PoolNodeCounts[]	Uma lista de Contagens de Nós de Computação por Conjunto.