Pool - List Usage Metrics
Zobrazí seznam metrik využití agregovaných podle fondu v jednotlivých časových intervalech pro zadaného klienta.
Pokud nezadáte klauzuli $filter včetně poolId, odpověď zahrne 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ě startTime nebo endTime, tyto filtry ve výchozím nastavení nastaví počáteční a koncový čas posledního aktuálně dostupného intervalu agregace. to znamená, že se vrátí pouze poslední interval agregace.
GET {batchUrl}/poolusagemetrics?api-version=2023-11-01.18.0
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Základní adresa URL pro všechny požadavky Azure Batch služby. |
api-version
|
query | True |
string |
Verze rozhraní API klienta. |
$filter
|
query |
string |
Klauzule $filter OData. Další informace o vytváření tohoto filtru najdete v tématu https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. |
|
endtime
|
query |
string date-time |
Poslední čas, od kterého se mají zahrnout metriky. Musí to být alespoň dvě hodiny před aktuálním časem. Pokud není zadaný, použije se výchozí koncový čas posledního aktuálně dostupného intervalu agregace. |
|
maxresults
|
query |
integer int32 |
Maximální počet položek, které se mají v odpovědi vrátit. Vrátí se maximálně 1000 výsledků. |
|
starttime
|
query |
string date-time |
Nejstarší čas, od kterého se mají zahrnout metriky. Musí to být nejméně dvě a půl hodiny před aktuálním časem. Pokud není zadaný, použije se výchozí čas zahájení posledního aktuálně dostupného intervalu agregace. |
|
timeout
|
query |
integer int32 |
Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund. |
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, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Určuje, jestli má server v odpovědi vrátit client-request-id. |
|
ocp-date |
string date-time-rfc1123 |
Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Odpověď obsahující seznam podrobností o využití fondu. Hlavičky
|
|
Other Status Codes |
Chyba ze služby Batch. |
Zabezpečení
azure_auth
Microsoft Entra tok ověřovacího kódu 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=2023-11-01.18.0
Ukázková odpověď
{
"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 |
---|---|
Batch |
Služba Azure Batch obdržela chybovou odpověď. |
Batch |
Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi. |
Error |
Chybová zpráva přijatá v Azure Batch chybovou odpověď. |
Pool |
Výsledek výpisu metrik využití pro účet. |
Pool |
Metriky využití pro fond v intervalu agregace |
BatchError
Služba Azure Batch obdržela chybovou odpověď.
Name | Typ | Description |
---|---|---|
code |
string |
Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově. |
message |
Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní. |
|
values |
Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě. |
BatchErrorDetail
Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
Name | Typ | Description |
---|---|---|
key |
string |
Identifikátor určující význam value vlastnost. |
value |
string |
Další informace zahrnuté v chybové odpovědi. |
ErrorMessage
Chybová zpráva přijatá v Azure Batch chybovou odpověď.
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 |
Data metrik využití fondu. |
PoolUsageMetrics
Metriky využití pro fond v intervalu agregace
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 intervalu agregace, na který se vztahuje tato položka. |
totalCoreHours |
number |
Celkový počet hodin jádra použitých ve fondu během tohoto intervalu agregace. |
vmSize |
string |
Velikost virtuálních počítačů ve fondu. Všechny virtuální počítače ve fondu mají stejnou velikost. |