Compartilhar via

Pool - List Usage Metrics

  • Referência
Serviço:
Batch Service
Versão da API:
2024-07-01.20.0

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 uma 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 padrão para os horários de início e término do último intervalo de agregação atualmente disponível; ou seja, somente o último intervalo de agregação é retornado.

GET {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0
Com parâmetros opcionais: 
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$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#list-account-usage-metrics.
endtime
 query

string

date-time

A hora mais recente da qual incluir métricas. Isso deve ser pelo menos duas horas antes da hora atual. Se não for especificado, esse padrão será a hora de término do último intervalo de agregação atualmente disponível.
maxresults
 query

integer

int32

O número máximo de itens a serem retornados na resposta. Um máximo de 1000 resultados será retornado.
starttime
 query

string

date-time

A hora mais antiga da qual incluir métricas. Isso deve ser pelo menos duas horas e meia antes da hora atual. Se não for especificado, esse padrão será a 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 maior que 30, o padrão será usado.

Cabeçalho da solicitação

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

Nome Obrigatório 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

PoolListUsageMetricsResult

Uma resposta que contém a lista de detalhes de uso do Pool.

Cabeçalhos

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: 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

Pool list usage metrics

Solicitação de exemplo

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

Resposta de exemplo

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

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

O resultado de uma listagem das métricas de uso de uma conta.
PoolUsageMetrics

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

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.

PoolListUsageMetricsResult

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

Nome Tipo Description
odata.nextLink

string

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

PoolUsageMetrics[]

Os dados de métricas de uso do pool.

PoolUsageMetrics

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

Nome Tipo Description
endTime

string

A hora de término do intervalo de agregação coberto por essa entrada.
poolId

string

A ID do Pool cujas métricas são agregadas nesta entrada.
startTime

string

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

number

As horas principais totais usadas no pool durante esse intervalo de agregação.
vmSize

string

O tamanho das máquinas virtuais no Pool. Todas as VMs em um pool têm o mesmo tamanho.
Para obter informações sobre os tamanhos disponíveis de máquinas virtuais em Pools, consulte Escolher um tamanho de VM para nós de computação em um pool de lote do Azure (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).