Condividi tramite

Pools - List Pool Usage Metrics

Servizio:
Batch Service
Versione API:
2025-06-01

Elenca le metriche di utilizzo, aggregate per pool in intervalli di tempo individuali, per l'account specificato.
Se non si specifica una clausola $filter che include un poolId, la risposta include tutti i pool presenti nell'account nell'intervallo di tempo degli intervalli di aggregazione restituiti. Se non si specifica una clausola $filter che include un valore startTime o endTime, questi filtri vengono usati per impostazione predefinita per l'ora di inizio e di fine dell'ultimo intervallo di aggregazione attualmente disponibile; ovvero viene restituito solo l'ultimo intervallo di aggregazione.

GET {endpoint}/poolusagemetrics?api-version=2025-06-01
Con parametri facoltativi: 
GET {endpoint}/poolusagemetrics?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&startTime={startTime}&endtime={endtime}&$filter={$filter}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string (uri)

Endpoint dell'account Batch (ad esempio: https://batchaccount.eastus2.batch.azure.com).
api-version
 query True

string

minLength: 1

Versione dell'API da usare per questa operazione.
$filter
 query

string

Clausola di $filter OData. Per maggiori informazioni sulla costruzione di questo filtro, vedi https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime
 query

string (date-time)

L'ultimo momento per includere le metriche. Questo deve avvenire almeno due ore prima dell'ora attuale. Se non specificato, questo predefinito corrisponde all'orario di fine dell'ultimo intervallo di aggregazione attualmente disponibile.
maxresults
 query

integer (int32)

minimum: 1
maximum: 1000

Numero massimo di elementi da restituire nella risposta. Possono essere restituite un massimo di 1000 domande.
startTime
 query

string (date-time)

Il momento più antico da cui includere le metriche. Questo deve essere almeno due ore e mezza prima dell'ora attuale. Se non specificato, questo si riferisce all'orario di inizio dell'ultimo intervallo di aggregazione attualmente disponibile.
timeOut
 query

integer (int32)

Tempo massimo di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è superiore a 30, verrà utilizzato il valore predefinito.".

Intestazione della richiesta

Nome Necessario Tipo Descrizione
client-request-id

string

Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Indica se il server deve restituire l'ID richiesta client nella risposta.
ocp-date

string (date-time-rfc7231)

Ora di emissione della richiesta. Le librerie client in genere impostano questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.

Risposte

Nome Tipo Descrizione
200 OK

BatchPoolListUsageMetricsResult

La richiesta ha avuto esito positivo.

Intestazioni

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

BatchError

Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome Descrizione
https://batch.core.windows.net//.default

Esempio

Pool list usage metrics

Esempio di richiesta

GET {endpoint}/poolusagemetrics?api-version=2025-06-01

Risposta di esempio

Codice di stato:
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
    }
  ]
}

Definizioni

Nome Descrizione
BatchError

Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.
BatchErrorMessage

Messaggio di errore ricevuto in una risposta di errore di Azure Batch.
BatchPoolListUsageMetricsResult

Risultato di un elenco delle metriche di utilizzo per un account.
BatchPoolUsageMetrics

Metriche di utilizzo per un pool in un intervallo di aggregazione.

BatchError

Oggetto

Risposta di errore ricevuta dal servizio Azure Batch.

Nome Tipo Descrizione
code

string

Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message

BatchErrorMessage

Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values

BatchErrorDetail[]

Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Oggetto

Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.

Nome Tipo Descrizione
key

string

Identificatore che specifica il significato della proprietà Value.
value

string

Informazioni aggiuntive incluse nella risposta di errore.

BatchErrorMessage

Oggetto

Messaggio di errore ricevuto in una risposta di errore di Azure Batch.

Nome Tipo Descrizione
lang

string

Il codice linguistico del messaggio di errore.
value

string

Testo del messaggio.

BatchPoolListUsageMetricsResult

Oggetto

Risultato di un elenco delle metriche di utilizzo per un account.

Nome Tipo Descrizione
odata.nextLink

string (uri)

L'URL per ottenere il set di risultati successivo.
value

BatchPoolUsageMetrics[]

I dati delle metriche di utilizzo del pool.

BatchPoolUsageMetrics

Oggetto

Metriche di utilizzo per un pool in un intervallo di aggregazione.

Nome Tipo Descrizione
endTime

string (date-time)

Il tempo di fine dell'intervallo di aggregazione coperto da questa voce.
poolId

string

L'ID del Pool le cui metriche sono aggregate in questa voce.
startTime

string (date-time)

L'orario di inizio dell'intervallo di aggregazione coperto da questa voce.
totalCoreHours

number (float)

Le ore di core totali utilizzate nel Pool durante questo intervallo di aggregazione.
vmSize

string

Dimensioni delle macchine virtuali nel pool. Tutte le VM in un Pool hanno la stessa dimensione. Per informazioni sulle dimensioni disponibili delle macchine virtuali nei pool, vedere Scegliere una dimensione di macchina virtuale per i nodi di calcolo in un pool di Azure Batch (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).