Megosztás a következőn keresztül:

Pool - List Usage Metrics

  • Referencia
Szolgáltatás:
Batch Service
API-verzió:
2024-07-01.20.0

A készlet által összesített használati metrikákat sorolja fel az egyes időintervallumokban a megadott fiókhoz.
Ha nem ad meg $filter záradékot, beleértve a készletazonosítót is, a válasz tartalmazza a fiókban meglévő összes készletet a visszaadott összesítési intervallumok időtartományában. Ha nem ad meg $filter záradékot, beleértve a startTime-ot vagy az endTime-ot, ezek a szűrők alapértelmezés szerint az aktuálisan elérhető utolsó összesítési időköz kezdő és befejező időpontjaira vannak beszűkülve; vagyis csak az utolsó összesítési időköz lesz visszaadva.

GET {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0
Opcionális paraméterekkel: 
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.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

OData $filter záradék. A szűrő felépítésével kapcsolatos további információkért lásd: https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime
 query

string

date-time

A metrikák hozzáadásának legújabb 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 végéig van megadva.
maxresults
 query

integer

int32

A válaszban visszaadandó elemek maximális száma. A rendszer legfeljebb 1000 találatot 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 kiszolgáló által a kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 másodperc. Ha az érték nagyobb, mint 30, akkor a rendszer az alapértelmezett értéket használja.

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 guid formában, díszítés nélkül, például kapcsos zárójelek, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Azt jelzi, hogy a kiszolgálónak vissza kell-e adnia az ügyfél-kérelem azonosítóját a válaszban.
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óra-időpontra állítják be; állítsa be explicit módon, ha közvetlenül a REST API-t hívja meg.

Válaszok

Name Típus Description
200 OK

PoolListUsageMetricsResult

A készlet használati adatainak 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ódfolyamat

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

GET account.region.batch.azure.com/poolusagemetrics?api-version=2024-07-01.20.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

Az Azure Batch szolgáltatástól kapott hibaválasz.
BatchErrorDetail

Az 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áinak felsorolása.
PoolUsageMetrics

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

BatchError

Az Azure Batch szolgáltatástól kapott hibaválasz.

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, amelyek további részleteket tartalmaznak a hibáról.

BatchErrorDetail

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

Name Típus Description
key

string

Az Érték tulajdonság jelentését meghatározó azonosító.
value

string

A hibaválasz további információi.

ErrorMessage

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

Name Típus Description
lang

string

A hibaüzenet nyelvi kódja
value

string

Az üzenet szövege.

PoolListUsageMetricsResult

Egy fiók használati metrikáinak felsorolása.

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áit ebben a bejegyzésben összesíti a rendszer.
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 virtuális gépek mérete a készletben. A készlet összes virtuális gépe azonos méretű.
A készletekben elérhető virtuális gépek méretéről további információt az Azure Batch-készletben (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes) található számítási csomópontok virtuálisgép-méretének kiválasztása című témakörben talál.