Pools - List Pool Usage Metrics

Služba:: Batch Service

Verze rozhraní API:: 2025-06-01

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 {endpoint}/poolusagemetrics?api-version=2025-06-01

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Koncový bod účtu Batch (například: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$filter	query		string	Klauzule $filter OData. Pro více informací o konstrukci tohoto filtru viz https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime	query		string (date-time)	Nejnovější doba, kdy lze zařadit metriky. To musí být alespoň dvě hodiny před aktuálním časem. Pokud není specifikováno, výchozí čas je na konci posledního aktuálně dostupného agregačního intervalu.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Maximální počet položek, které se mají vrátit v odpovědi. Maximálně 1000 žádostí lze vrátit.
startTime	query		string (date-time)	Nejranější doba, od které zahrnout metriky. To musí být alespoň dvě a půl hodiny před aktuálním časem. Pokud není specifikováno, výchozí je počáteční čas posledního aktuálně dostupného agregačního intervalu.
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

Name	Typ	Description
client-request-id	string	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-rfc7231)	Č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	BatchPoolListUsageMetricsResult	Požadavek byl úspěšný. Hlavičky ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Neočekávaná chybová odpověď

Name

Typ

Description

200 OK

BatchPoolListUsageMetricsResult

Požadavek byl úspěšný.

Hlavičky

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Neočekávaná chybová odpověď

Zabezpečení

OAuth2Auth

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

Rozsahy

Name	Description
https://batch.core.windows.net//.default

Příklady

Pool list usage metrics

Ukázkový požadavek

HTTP

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

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
BatchErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
BatchPoolListUsageMetricsResult	Výsledek výpisu metrik využití pro účet.
BatchPoolUsageMetrics	Metriky využití fondu v rámci agregačního intervalu

BatchError

Objekt

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

Objekt

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.

BatchErrorMessage

Objekt

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

Name	Typ	Description
lang	string	Jazykový kód chybové zprávy.
value	string	Text zprávy.

BatchPoolListUsageMetricsResult

Objekt

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

Name	Typ	Description
odata.nextLink	string (uri)	Adresa URL pro získání další sady výsledků.
value	BatchPoolUsageMetrics[]	Data o metrikách využití poolu.

BatchPoolUsageMetrics

Objekt

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

Name	Typ	Description
endTime	string (date-time)	Čas konce agregačního intervalu pokrytého tímto záznamem.
poolId	string	ID poolu, jehož metriky jsou v tomto záznamu agregovány.
startTime	string (date-time)	Počáteční čas agregačního intervalu pokrytého tímto záznamem.
totalCoreHours	number (float)	Celkové základní hodiny použité v Poolu během tohoto agregačního období.
vmSize	string	Velikost virtuálníchpočítačůch Všechny VM v Poolu jsou stejně velké. 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 Azure Batch (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).