Pool - List Usage Metrics
Répertorie les métriques d’utilisation, agrégées par pool à 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 sont par défaut les heures de début et de fin de la dernière intervalle d’agrégation actuellement disponible ; autrement dit, seul le dernier intervalle d’agrégation est retourné.
GET {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
batch
|
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 OData $filter. Pour plus d’informations sur la construction de ce filtre, consultez https://learn.microsoft.com/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. Il doit s’agir d’au moins deux heures avant l’heure actuelle. S’il n’est pas spécifié, cette valeur est définie par défaut sur 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. Il doit s’agir d’au moins deux heures et demi avant l’heure actuelle. S’il n’est pas spécifié, cette valeur est définie par défaut sur l’heure de début du dernier intervalle d’agrégation actuellement disponible. |
|
timeout
|
query |
integer int32 |
Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, la valeur par défaut est utilisée à la place. |
En-tête de la demande
Media Types: "application/json; odata=minimalmetadata"
Nom | Obligatoire | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Indique si le serveur doit retourner l’ID 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 de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Réponse contenant la liste des détails d’utilisation du pool. En-têtes
|
|
Other Status Codes |
Erreur du service Batch. |
Sécurité
azure_auth
Flux de code d’authentification Microsoft Entra OAuth 2.0
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Authorization
Type:
apiKey
Dans:
header
Exemples
Pool list usage metrics
Exemple de requête
GET account.region.batch.azure.com/poolusagemetrics?api-version=2024-07-01.20.0
Exemple de réponse
{
"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 |
---|---|
Batch |
Réponse d’erreur reçue du service Azure Batch. |
Batch |
Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch. |
Error |
Message d’erreur reçu dans une réponse d’erreur Azure Batch. |
Pool |
Résultat d’une liste des métriques d’utilisation d’un compte. |
Pool |
Métriques d’utilisation pour un pool entre 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 programme. |
message |
Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur. |
|
values |
Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur. |
BatchErrorDetail
Élément d’informations supplémentaires inclus 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 le jeu de résultats suivant. |
value |
Données des métriques d’utilisation du pool. |
PoolUsageMetrics
Métriques d’utilisation pour un pool entre 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 sont de la même taille. |