Pool - List Usage Metrics

  • Référence
Service:
Batch Service
API Version:
2023-11-01.18.0

Répertorie les métriques d’utilisation, agrégées par pool sur des intervalles de temps individuels, pour le compte spécifié.
Si vous ne spécifiez pas de clause $filter incluant un poolId, la réponse inclut tous les pools qui existaient dans le compte dans l’intervalle de temps des intervalles d’agrégation retournés. Si vous ne spécifiez pas de clause $filter incluant un startTime ou endTime, ces filtres correspondent par défaut aux heures de début et de fin du dernier intervalle d’agrégation actuellement disponible ; autrement dit, seul le dernier intervalle d’agrégation est retourné.

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

Paramètres URI

Nom Dans Obligatoire Type Description
batchUrl
 path True

string

URL de base pour toutes les demandes de service Azure Batch.
api-version
 query True

string

Version de l’API cliente.
$filter
 query

string

Clause de $filter OData. Pour plus d’informations sur la construction de ce filtre, consultez https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime
 query

string

date-time

Heure la plus récente à partir de laquelle inclure des métriques. Cela doit être au moins deux heures avant l’heure actuelle. S’il n’est pas spécifié, cette valeur correspond à l’heure de fin du dernier intervalle d’agrégation actuellement disponible.
maxresults
 query

integer

int32

Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1 000 résultats sera retourné.
starttime
 query

string

date-time

Heure la plus ancienne à partir de laquelle inclure des métriques. Cela doit être au moins deux heures et demie avant l’heure actuelle. S’il n’est pas spécifié, cette valeur correspond à l’heure de début du dernier intervalle d’agrégation actuellement disponible.
timeout
 query

integer

int32

Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

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

Nom Obligatoire Type Description
client-request-id

string

uuid

Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Indique si le serveur doit retourner le client-request-id dans la réponse.
ocp-date

string

date-time-rfc1123

Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement.

Réponses

Nom Type Description
200 OK

PoolListUsageMetricsResult

Réponse contenant la liste des détails de l’utilisation du pool.

Headers

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

BatchError

Erreur du service Batch.

Sécurité

azure_auth

Microsoft Entra flux de code d’authentification OAuth 2.0

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

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
In: header

Exemples

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

Définitions

Nom Description
BatchError

Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail

Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch.
ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.
PoolListUsageMetricsResult

Résultat d’une liste des métriques d’utilisation d’un compte.
PoolUsageMetrics

Métriques d’utilisation d’un pool sur un intervalle d’agrégation.

BatchError

Réponse d’erreur reçue du service Azure Batch.

Nom Type Description
code

string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message

ErrorMessage

Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values

BatchErrorDetail[]

Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch.

Nom Type Description
key

string

Identificateur spécifiant la signification de la propriété Value.
value

string

Informations supplémentaires incluses dans la réponse d’erreur.

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom Type Description
lang

string

Code de langue du message d’erreur
value

string

Texte du message.

PoolListUsageMetricsResult

Résultat d’une liste des métriques d’utilisation d’un compte.

Nom Type Description
odata.nextLink

string

URL permettant d’obtenir l’ensemble de résultats suivant.
value

PoolUsageMetrics[]

Données des métriques d’utilisation du pool.

PoolUsageMetrics

Métriques d’utilisation d’un pool sur un intervalle d’agrégation.

Nom Type Description
endTime

string

Heure de fin de l’intervalle d’agrégation couvert par cette entrée.
poolId

string

ID du pool dont les métriques sont agrégées dans cette entrée.
startTime

string

Heure de début de l’intervalle d’agrégation couvert par cette entrée.
totalCoreHours

number

Nombre total d’heures principales utilisées dans le pool pendant cet intervalle d’agrégation.
vmSize

string

Taille des machines virtuelles dans le pool. Toutes les machines virtuelles d’un pool ont la même taille.
Pour plus d’informations sur les tailles disponibles des machines virtuelles dans les pools, consultez Choisir une taille de machine virtuelle pour les nœuds de calcul dans un pool Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).