Condividi tramite

Pool - List Usage Metrics

  • Riferimento
Servizio:
Batch Service
Versione API:
2024-07-01.20.0

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 {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0
Con parametri facoltativi: 
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Parametri dell'URI

Nome In Necessario Tipo Descrizione
batchUrl
 path True

string

URL di base per tutte le richieste del servizio Azure Batch.
api-version
 query True

string

Versione dell'API client.
$filter
 query

string

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

string

date-time

Ora più recente da cui includere le metriche. Deve essere almeno due ore prima dell'ora corrente. Se questa impostazione predefinita non è specificata, corrisponde 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

Prima ora da cui includere le metriche. Questa operazione deve essere di almeno due ore e mezza prima dell'ora corrente. Se questa impostazione predefinita non è specificata, corrisponde all'ora 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 è maggiore di 30, verrà usato il valore predefinito.

Intestazione della richiesta

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

Nome Necessario Tipo Descrizione
client-request-id

string

uuid

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-rfc1123

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

PoolListUsageMetricsResult

Risposta contenente l'elenco dei dettagli di utilizzo del pool.

Intestazioni

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

BatchError

Errore del servizio Batch.

Sicurezza

azure_auth

Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0

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

Ambiti

Nome Descrizione
user_impersonation Rappresentare l'account utente

Authorization

Tipo: apiKey
In: header

Esempio

Pool list usage metrics

Esempio di richiesta

GET account.region.batch.azure.com/poolusagemetrics?api-version=2024-07-01.20.0

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.
ErrorMessage

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

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

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 utilizzati a livello di codice.
message

ErrorMessage

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

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.

ErrorMessage

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

Nome Tipo Descrizione
lang

string

Codice linguistico 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 di risultati successivo.
value

PoolUsageMetrics[]

Dati delle 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 sono aggregate in questa voce.
startTime

string

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

number

Ore di core totali usate nel pool durante questo intervallo di aggregazione.
vmSize

string

Dimensioni delle macchine virtuali nel pool. Tutte le macchine virtuali in un pool hanno le stesse dimensioni.
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).