Account - List Pool Node Counts
Obtém o número de Nós de Computação em cada estado, agrupados por Pool. Observe que os números retornados nem sempre podem estar atualizados. Se você precisar de contagens exatas de nós, use uma consulta de lista.
GET {batchUrl}/nodecounts?api-version=2023-11-01.18.0
GET {batchUrl}/nodecounts?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
A URL base para todas as solicitações de serviço Lote do Azure. |
api-version
|
query | True |
string |
Versão da API do cliente. |
$filter
|
query |
string |
Uma cláusula de $filter OData. Para obter mais informações sobre como construir esse 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 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. |
Cabeçalho da solicitação
Media Types: "application/json; odata=minimalmetadata"
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
A identidade de 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 client-request-id 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 |
A resposta contém o número de nós de computação em cada estado do Nó de Computação, agrupados por pool. Headers
|
|
Other Status Codes |
O erro do serviço do Lote. |
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
Nome | Description |
---|---|
user_impersonation | Representar sua conta de usuário |
Authorization
Type:
apiKey
In:
header
Exemplos
NodeCountsPayload
Sample Request
GET account.region.batch.azure.com/nodecounts?api-version=2023-11-01.18.0
Sample Response
{
"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
Nome | Description |
---|---|
Batch |
Uma resposta de erro recebida do serviço Lote do Azure. |
Batch |
Um item de informações adicionais incluído em uma resposta de erro Lote do Azure. |
Error |
Uma mensagem de erro recebida em uma resposta de erro Lote do Azure. |
Node |
O número de Nós de Computação em cada estado do Nó de Computação. |
Pool |
O número de nós de computação em cada estado para um pool. |
Pool |
O resultado da listagem das contagens de Nós de Computação na Conta. |
BatchError
Uma resposta de erro recebida do serviço 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 |
Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário. |
|
values |
Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro. |
BatchErrorDetail
Um item de informações adicionais incluído em uma resposta de erro 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 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. |
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 preempto. |
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. |
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 |
O número de nós de computação dedicados em cada estado. |
|
lowPriority |
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 de Nós de Computação na Conta.
Nome | Tipo | Description |
---|---|---|
odata.nextLink |
string |
A URL para obter o próximo conjunto de resultados. |
value |
Uma lista de contagens de nós de computação por pool. |