Pool - List Usage Metrics

  • Referencia
Service:
Batch Service
API Version:
2023-11-01.18.0

Enumera las métricas de uso, agregadas por Grupo en intervalos de tiempo individuales, para la cuenta especificada.
Si no especifica una cláusula de $filter, incluido un poolId, la respuesta incluye todos los grupos que existían en la cuenta en el intervalo de tiempo de los intervalos de agregación devueltos. Si no especifica una cláusula $filter que incluya un valor startTime o endTime, estos filtros tienen como valor predeterminado las horas de inicio y finalización del último intervalo de agregación disponible actualmente; es decir, solo se devuelve el último intervalo de agregación.

GET {batchUrl}/poolusagemetrics?api-version=2023-11-01.18.0
With optional parameters: 
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parámetros de identificador URI

Nombre En Requerido Tipo Description
batchUrl
 path True

string

Dirección URL base de todas las solicitudes de servicio de Azure Batch.
api-version
 query True

string

Versión de la API de cliente.
$filter
 query

string

Una cláusula de $filter OData. Para obtener más información sobre cómo construir este filtro, vea https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime
 query

string

date-time

La hora más reciente desde la que se van a incluir métricas. Debe ser al menos dos horas antes de la hora actual. Si no se especifica, este valor predeterminado es la hora de finalización del último intervalo de agregación disponible actualmente.
maxresults
 query

integer

int32

Número máximo de elementos que se van a devolver en la respuesta. Se devolverá un máximo de 1000 resultados.
starttime
 query

string

date-time

La hora más temprana desde la que se van a incluir las métricas. Debe ser de al menos dos y media horas antes de la hora actual. Si no se especifica, este valor predeterminado es la hora de inicio del último intervalo de agregación disponible actualmente.
timeout
 query

integer

int32

Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

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

Nombre Requerido Tipo Description
client-request-id

string

uuid

La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date

string

date-time-rfc1123

Hora a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre Tipo Description
200 OK

PoolListUsageMetricsResult

Respuesta que contiene la lista de detalles de uso del grupo.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

Error del servicio Batch.

Seguridad

azure_auth

flujo de código de autenticación de OAuth 2.0 Microsoft Entra

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

Scopes

Nombre Description
user_impersonation Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

Pool list usage metrics

Sample Request

GET account.region.batch.azure.com/poolusagemetrics?api-version=2023-11-01.18.0

Sample Response

Status code:
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
    }
  ]
}

Definiciones

Nombre Description
BatchError

Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.
ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.
PoolListUsageMetricsResult

Resultado de una lista de las métricas de uso de una cuenta.
PoolUsageMetrics

Métricas de uso de un grupo en un intervalo de agregación.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Nombre Tipo Description
code

string

Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message

ErrorMessage

Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values

BatchErrorDetail[]

Colección de pares clave-valor que contiene detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.

Nombre Tipo Description
key

string

Identificador que especifica el significado de la propiedad Value.
value

string

La información adicional incluida con la respuesta de error.

ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.

Nombre Tipo Description
lang

string

Código de idioma del mensaje de error
value

string

Texto del mensaje.

PoolListUsageMetricsResult

Resultado de una lista de las métricas de uso de una cuenta.

Nombre Tipo Description
odata.nextLink

string

Dirección URL para obtener el siguiente conjunto de resultados.
value

PoolUsageMetrics[]

Datos de métricas de uso del grupo.

PoolUsageMetrics

Métricas de uso de un grupo en un intervalo de agregación.

Nombre Tipo Description
endTime

string

Hora de finalización del intervalo de agregación cubierto por esta entrada.
poolId

string

Identificador del grupo cuyas métricas se agregan en esta entrada.
startTime

string

Hora de inicio del intervalo de agregación cubierto por esta entrada.
totalCoreHours

number

Horas de núcleo totales usadas en el grupo durante este intervalo de agregación.
vmSize

string

Tamaño de las máquinas virtuales del grupo. Todas las máquinas virtuales de un grupo tienen el mismo tamaño.
Para obtener información sobre los tamaños disponibles de las máquinas virtuales en grupos, consulte Elección de un tamaño de máquina virtual para nodos de proceso en un grupo de Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).