Pool - List Usage Metrics

Tjänst:

Batch Service

API-version:

2024-07-01.20.0

Visar en lista över användningsstatistik, aggregerade efter pool över enskilda tidsintervall, för det angivna kontot.
Om du inte anger en $filter-sats, inklusive ett pool-ID, innehåller svaret alla pooler som fanns i kontot i tidsintervallet för de returnerade aggregeringsintervallen. Om du inte anger en $filter-sats, inklusive en startTime- eller endTime-sats, standardvärdet för dessa filter till start- och sluttiderna för det senaste aggregeringsintervallet som för närvarande är tillgängligt. Dvs. returneras endast det sista aggregeringsintervallet.

GET {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0

Med valfria parametrar:

GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch-tjänstbegäranden.
api-version	query	True	string	Klient-API-version.
$filter	query		string	En OData-$filter-sats. Mer information om hur du skapar det här filtret finns i https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime	query		string date-time	Den senaste tiden som mått ska inkluderas från. Detta måste vara minst två timmar före den aktuella tiden. Om detta inte anges är standardvärdet sluttiden för det senaste aggregeringsintervallet som för närvarande är tillgängligt.
maxresults	query		integer int32	Det maximala antalet objekt som ska returneras i svaret. Högst 1 000 resultat returneras.
starttime	query		string date-time	Den tidigaste tid från vilken mått ska inkluderas. Detta måste vara minst två och en halv timme före den aktuella tiden. Om det inte anges är det här standardvärdet för starttiden för det senaste aggregeringsintervallet som är tillgängligt för närvarande.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet i stället.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt.

Svar

Name	Typ	Description
200 OK	PoolListUsageMetricsResult	Ett svar som innehåller listan med information om poolanvändning. Sidhuvuden client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

Pool list usage metrics

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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
    }
  ]
}

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch-felsvar.
PoolListUsageMetricsResult	Resultatet av en lista över användningsstatistik för ett konto.
PoolUsageMetrics	Användningsstatistik för en pool över ett aggregeringsintervall.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

PoolListUsageMetricsResult

Resultatet av en lista över användningsstatistik för ett konto.

Name	Typ	Description
odata.nextLink	string	URL:en för att hämta nästa uppsättning resultat.
value	PoolUsageMetrics[]	Data om poolanvändningsstatistik.

PoolUsageMetrics

Användningsstatistik för en pool över ett aggregeringsintervall.

Name	Typ	Description
endTime	string	Sluttiden för det aggregeringsintervall som omfattas av den här posten.
poolId	string	ID:t för poolen vars mått aggregeras i den här posten.
startTime	string	Starttiden för det aggregeringsintervall som omfattas av den här posten.
totalCoreHours	number	Totalt antal kärntimmar som används i poolen under det här aggregeringsintervallet.
vmSize	string	Storleken på virtuella datorer i poolen. Alla virtuella datorer i en pool har samma storlek. Information om tillgängliga storlekar på virtuella datorer i pooler finns i Välja en VM-storlek för beräkningsnoder i en Azure Batch-pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).