Pool - List Usage Metrics

Szolgáltatás:

Batch Service

API-verzió:

2023-11-01.18.0

A megadott fiókhoz tartozó használati metrikákat sorolja fel készletenként összesítve az egyes időintervallumokban.
Ha nem ad meg $filter záradékot a poolId azonosítóval együtt, a válasz tartalmazza az összes készletet, amely a visszaadott aggregációs intervallumok időtartományában létezett a fiókban. Ha nem ad meg $filter záradékot, beleértve a startTime vagy az endTime paramétert, ezek a szűrők alapértelmezés szerint az aktuálisan elérhető utolsó összesítési időköz kezdő és záró időpontjaira vannak beszűkülve; vagyis csak az utolsó összesítési időköz lesz visszaadva.

GET {batchUrl}/poolusagemetrics?api-version=2023-11-01.18.0

Opcionális paraméterekkel:

GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI-paraméterek

Name	In	Kötelező	Típus	Description
batchUrl	path	True	string	Az összes Azure Batch szolgáltatáskérés alap URL-címe.
api-version	query	True	string	Ügyfél API-verziója.
$filter	query		string	Egy OData $filter záradék. A szűrő felépítésével kapcsolatos további információkért lásd: https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime	query		string date-time	A metrikák hozzáadásának legkésőbbi időpontja. Ennek legalább két órával az aktuális időpont előtt kell lennie. Ha nincs megadva, ez az alapértelmezett érték az aktuálisan elérhető utolsó összesítési időköz befejezési időpontjára esik.
maxresults	query		integer int32	A válaszban visszaadandó elemek maximális száma. A rendszer legfeljebb 1000 eredményt ad vissza.
starttime	query		string date-time	A metrikák hozzáadásának legkorábbi időpontja. Ennek legalább két és fél órával az aktuális idő előtt kell lennie. Ha nincs megadva, ez az alapértelmezett érték az aktuálisan elérhető utolsó összesítési időköz kezdő időpontjára esik.
timeout	query		integer int32	A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp.

Kérelem fejléce

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

Name	Kötelező	Típus	Description
client-request-id		string uuid	A hívó által generált kérési identitás, olyan GUID formátumban, amely nem rendelkezik díszítéssel, például kapcsos zárójelekkel, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Azt határozza meg, hogy a kiszolgálónak vissza kell-e küldenie a válaszban szereplő client-request-id azonosítót.
ocp-date		string date-time-rfc1123	A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróraidőre állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg.

Válaszok

Name	Típus	Description
200 OK	PoolListUsageMetricsResult	A készlethasználat részleteinek listáját tartalmazó válasz. Fejlécek client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	A Batch szolgáltatás hibája.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Authorization

Típus: apiKey
In: header

Példák

Pool list usage metrics

Mintakérelem

HTTP

GET account.region.batch.azure.com/poolusagemetrics?api-version=2023-11-01.18.0

Mintaválasz

Állapotkó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
    }
  ]
}

Definíciók

Name	Description
BatchError	Hibaválasz érkezett a Azure Batch szolgáltatástól.
BatchErrorDetail	Egy Azure Batch hibaválaszban szereplő további információk egy eleme.
ErrorMessage	Hibaüzenet érkezett egy Azure Batch hibaválaszban.
PoolListUsageMetricsResult	Egy fiók használati metrikáit listázó eredmény.
PoolUsageMetrics	Egy készlet használati metrikái egy összesítési intervallumban.

BatchError

Hibaválasz érkezett a Azure Batch szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	ErrorMessage	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values	BatchErrorDetail[]	Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról.

BatchErrorDetail

Egy Azure Batch hibaválaszban szereplő további információk egy eleme.

Name	Típus	Description
key	string	Egy azonosító, amely az Érték tulajdonság jelentését adja meg.
value	string	A hibaválaszban szereplő további információk.

ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.

Name	Típus	Description
lang	string	A hibaüzenet nyelvkódja
value	string	Az üzenet szövege.

PoolListUsageMetricsResult

Egy fiók használati metrikáit listázó eredmény.

Name	Típus	Description
odata.nextLink	string	A következő találatkészlet lekéréséhez tartozó URL-cím.
value	PoolUsageMetrics[]	A készlet használati metrikáinak adatai.

PoolUsageMetrics

Egy készlet használati metrikái egy összesítési intervallumban.

Name	Típus	Description
endTime	string	A bejegyzés által lefedett összesítési időköz záró időpontja.
poolId	string	Annak a készletnek az azonosítója, amelynek metrikái ebben a bejegyzésben vannak összesítve.
startTime	string	A bejegyzés által lefedett összesítési időköz kezdő időpontja.
totalCoreHours	number	A készletben az összesítési időköz során használt teljes magórák száma.
vmSize	string	A készletben lévő virtuális gépek mérete. A készlet összes virtuális gépe azonos méretű. A készletekben elérhető virtuális gépek méretével kapcsolatos információkért lásd: Virtuálisgép-méret kiválasztása számítási csomópontokhoz egy Azure Batch készletben (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).