Pool - List Usage Metrics
Elenca le metriche di utilizzo, aggregate in pool tra singoli intervalli di tempo, per l'account specificato.
Se non si specifica una clausola $filter inclusa un poolId, la risposta include tutti i pool esistenti nell'intervallo di tempo degli intervalli di aggregazione restituiti. Se non si specifica una clausola $filter, inclusa una clausola startTime o endTime, questi filtri vengono predefiniti per l'ora di inizio e fine dell'ultimo intervallo di aggregazione attualmente disponibile; ovvero, viene restituito solo l'ultimo intervallo di aggregazione.
GET {batchUrl}/poolusagemetrics?api-version=2023-11-01.18.0GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
batch
|
path | True |
string |
URL di base per tutte le richieste di servizio Azure Batch. |
|
api-version
|
query | True |
string |
Versione dell'API client. |
|
$filter
|
query |
string |
Clausola OData $filter. Per altre informazioni sulla costruzione di questo filtro, vedere https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. |
|
|
endtime
|
query |
string date-time |
Ora più recente da cui includere le metriche. Questo deve essere almeno due ore prima dell'ora corrente. Se non è specificato questo valore predefinito all'ora di fine dell'ultimo intervallo di aggregazione attualmente disponibile. |
|
|
maxresults
|
query |
integer int32 |
Numero massimo di elementi da restituire nella risposta. Verrà restituito un massimo di 1000 risultati. |
|
|
starttime
|
query |
string date-time |
La prima volta da cui includere le metriche. Questo deve essere almeno due e mezzo ore prima dell'ora corrente. Se non è specificato questo valore predefinito all'ora di inizio dell'ultimo intervallo di aggregazione attualmente disponibile. |
|
|
timeout
|
query |
integer int32 |
Tempo massimo per cui il server può trascorrere l'elaborazione della richiesta, in secondi. Il valore predefinito è 30 secondi. |
Intestazione della richiesta
Media Types: "application/json; odata=minimalmetadata"
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| client-request-id |
string uuid |
Identità richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50E-2D56-4CD3-8152-34347DC9F2B0. |
|
| return-client-request-id |
boolean |
Se il server deve restituire l'ID richiesta client nella risposta. |
|
| ocp-date |
string date-time-rfc1123 |
Ora in cui è stata eseguita la richiesta. Le librerie client in genere impostano l'ora dell'orologio del sistema corrente; impostarla in modo esplicito se si chiama direttamente l'API REST. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
Risposta contenente l'elenco dei dettagli sull'utilizzo del pool. Headers
|
|
| Other Status Codes |
Errore dal servizio Batch. |
Sicurezza
azure_auth
Microsoft Entra flusso di codice di autenticazione OAuth 2.0
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nome | Descrizione |
|---|---|
| user_impersonation | Rappresentare l'account utente |
Authorization
Type:
apiKey
In:
header
Esempio
Pool list usage metrics
Sample Request
GET account.region.batch.azure.com/poolusagemetrics?api-version=2023-11-01.18.0
Sample Response
{
"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
}
]
}Definizioni
| Nome | Descrizione |
|---|---|
|
Batch |
Risposta di errore ricevuta dal servizio Azure Batch. |
|
Batch |
Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch. |
|
Error |
Messaggio di errore ricevuto in una risposta di errore Azure Batch. |
|
Pool |
Risultato di un elenco delle metriche di utilizzo per un account. |
|
Pool |
Metriche di utilizzo per un pool in un intervallo di aggregazione. |
BatchError
Risposta di errore ricevuta dal servizio Azure Batch.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice. |
| message |
Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente. |
|
| values |
Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore. |
BatchErrorDetail
Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.
| Nome | Tipo | Descrizione |
|---|---|---|
| key |
string |
Identificatore che specifica il significato della proprietà Value. |
| value |
string |
Informazioni aggiuntive incluse nella risposta all'errore. |
ErrorMessage
Messaggio di errore ricevuto in una risposta di errore Azure Batch.
| Nome | Tipo | Descrizione |
|---|---|---|
| lang |
string |
Codice del linguaggio del messaggio di errore |
| value |
string |
Testo del messaggio. |
PoolListUsageMetricsResult
Risultato di un elenco delle metriche di utilizzo per un account.
| Nome | Tipo | Descrizione |
|---|---|---|
| odata.nextLink |
string |
URL per ottenere il set successivo di risultati. |
| value |
Dati sulle metriche di utilizzo del pool. |
PoolUsageMetrics
Metriche di utilizzo per un pool in un intervallo di aggregazione.
| Nome | Tipo | Descrizione |
|---|---|---|
| endTime |
string |
Ora di fine dell'intervallo di aggregazione coperto da questa voce. |
| poolId |
string |
ID del pool le cui metriche vengono aggregate in questa voce. |
| startTime |
string |
Ora di inizio dell'intervallo di aggregazione coperto da questa voce. |
| totalCoreHours |
number |
Le ore di base totali usate nel pool durante questo intervallo di aggregazione. |
| vmSize |
string |
Dimensioni delle macchine virtuali nel pool. Tutte le macchine virtuali in un pool sono le stesse dimensioni. |