Partilhar via

Pools - List Pool Usage Metrics

Serviço:
Batch Service
Versão da API:
2025-06-01

Lista as métricas de uso, agregadas por Pool em intervalos de tempo individuais, para a Conta especificada.
Se você não especificar uma cláusula $filter incluindo um poolId, a resposta incluirá todos os Pools que existiam na Conta no intervalo de tempo dos intervalos de agregação retornados. Se você não especificar uma cláusula $filter incluindo startTime ou endTime, esses filtros serão padronizados para as horas de início e término do último intervalo de agregação atualmente disponível; ou seja, apenas o último intervalo de agregação é retornado.

GET {endpoint}/poolusagemetrics?api-version=2025-06-01
Com parâmetros opcionais: 
GET {endpoint}/poolusagemetrics?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&startTime={startTime}&endtime={endtime}&$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-account-usage-metrics.
endtime
 query

string (date-time)

A última altura para incluir métricas. Isto deve ser pelo menos duas horas antes da hora atual. Se não especificado, isto corresponde por defeito à hora final do último intervalo de agregação atualmente disponível.
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.
startTime
 query

string (date-time)

O momento mais antigo para incluir métricas. Isto deve ser pelo menos duas horas e meia antes da hora atual. Se não for especificado, isto corresponde automaticamente à hora de início do último intervalo de agregação atualmente disponível.
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 Necessário 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

BatchPoolListUsageMetricsResult

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

Pool list usage metrics

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "startTime": "2013-04-01T00:00:00Z",
      "endTime": "2013-04-01T00:30:00Z",
      "poolId": "p1",
      "vmSize": "a1",
      "totalCoreHours": 39.384838
    },
    {
      "startTime": "2013-04-01T00:30:00Z",
      "endTime": "2013-04-01T01:00:00Z",
      "poolId": "p2",
      "vmSize": "a8",
      "totalCoreHours": 3039.384838
    }
  ]
}

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

O resultado de uma listagem das métricas de uso de uma Conta.
BatchPoolUsageMetrics

Métricas de uso de um Pool em um intervalo de agregação.

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.

BatchPoolListUsageMetricsResult

Object

O resultado de uma listagem das métricas de uso de uma Conta.

Name Tipo Description
odata.nextLink

string (uri)

O URL para obter o próximo conjunto de resultados.
value

BatchPoolUsageMetrics[]

Os dados das métricas de utilização do Pool.

BatchPoolUsageMetrics

Object

Métricas de uso de um Pool em um intervalo de agregação.

Name Tipo Description
endTime

string (date-time)

O tempo final do intervalo de agregação coberto por esta entrada.
poolId

string

O ID do Pool cujas métricas estão agregadas nesta entrada.
startTime

string (date-time)

A hora de início do intervalo de agregação coberto por esta entrada.
totalCoreHours

number (float)

As horas totais de núcleo utilizadas no Pool durante este intervalo de agregação.
vmSize

string

O tamanho das máquinas virtuais no Pool. Todas as VMs de um Pool têm o mesmo tamanho. Para obter informações sobre tamanhos disponíveis de máquinas virtuais em Pools, consulte Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).