Sdílet prostřednictvím

Pool - List Usage Metrics

  • Reference
Služba:
Batch Service
Verze rozhraní API:
2024-07-01.20.0

Uvádí metriky využití agregované podle fondu v jednotlivých časových intervalech pro zadaný účet.
Pokud nezadáte klauzuli $filter včetně id fondu, bude odpověď obsahovat všechny fondy, které existovaly v účtu v časovém rozsahu vrácených agregačních intervalů. Pokud nezadáte klauzuli $filter včetně času startTime nebo endTime, ve výchozím nastavení se použije počáteční a koncový čas posledního dostupného intervalu agregace; to znamená, že se vrátí pouze poslední interval agregace.

GET {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0
S volitelnými parametry: 
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
batchUrl
 path True

string

Základní adresa URL pro všechny požadavky služby Azure Batch.
api-version
 query True

string

Verze rozhraní API klienta.
$filter
 query

string

Klauzule $filter OData. Další informace o vytváření tohoto filtru naleznete v tématu https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime
 query

string

date-time

Nejnovější čas, od kterého se mají zahrnout metriky. Musí to být nejméně dvě hodiny před aktuálním časem. Pokud nezadáte výchozí hodnotu na koncový čas posledního dostupného intervalu agregace.
maxresults
 query

integer

int32

Maximální počet položek, které se mají vrátit v odpovědi. Vrátí se maximálně 1 000 výsledků.
starttime
 query

string

date-time

Nejstarší čas, od kterého se mají zahrnout metriky. Musí to být aspoň dvě a půl hodiny před aktuálním časem. Pokud nezadáte toto výchozí nastavení na počáteční čas posledního dostupného intervalu agregace.
timeout
 query

integer

int32

Maximální doba, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.

Hlavička požadavku

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

Name Vyžadováno Typ Description
client-request-id

string

uuid

Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.
ocp-date

string

date-time-rfc1123

Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.

Odpovědi

Name Typ Description
200 OK

PoolListUsageMetricsResult

Odpověď obsahující seznam podrobností o využití fondu.

Hlavičky

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

BatchError

Chyba ze služby Batch.

Zabezpečení

azure_auth

Tok ověřovacího kódu Microsoft Entra OAuth 2.0

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation Zosobnění uživatelského účtu

Authorization

Typ: apiKey
V: header

Příklady

Pool list usage metrics

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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
    }
  ]
}

Definice

Name Description
BatchError

Odpověď na chybu přijatá ze služby Azure Batch
BatchErrorDetail

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch
ErrorMessage

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
PoolListUsageMetricsResult

Výsledek výpisu metrik využití pro účet.
PoolUsageMetrics

Metriky využití fondu v rámci agregačního intervalu

BatchError

Odpověď na chybu přijatá ze služby Azure Batch

Name Typ Description
code

string

Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message

ErrorMessage

Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
values

BatchErrorDetail[]

Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

Name Typ Description
key

string

Identifikátor určující význam vlastnosti Value.
value

string

Další informace zahrnuté v odpovědi na chybu.

ErrorMessage

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

Name Typ Description
lang

string

Kód jazyka chybové zprávy
value

string

Text zprávy.

PoolListUsageMetricsResult

Výsledek výpisu metrik využití pro účet.

Name Typ Description
odata.nextLink

string

Adresa URL pro získání další sady výsledků.
value

PoolUsageMetrics[]

Data metrik využití fondu.

PoolUsageMetrics

Metriky využití fondu v rámci agregačního intervalu

Name Typ Description
endTime

string

Koncový čas intervalu agregace, na který se vztahuje tato položka.
poolId

string

ID fondu, jehož metriky jsou agregovány v této položce.
startTime

string

Počáteční čas agregačního intervalu, na který se vztahuje tato položka.
totalCoreHours

number

Celkový počet hodin jader použitých ve fondu během tohoto intervalu agregace.
vmSize

string

Velikost virtuálníchpočítačůch Všechny virtuální počítače ve fondu mají stejnou velikost.
Informace o dostupných velikostech virtuálních počítačů ve fondech najdete v tématu Volba velikosti virtuálního počítače pro výpočetní uzly ve fondu služby Azure Batch (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).