Delen via

Pool - List Usage Metrics

  • Referentie
Service:
Batch Service
API-versie:
2024-07-01.20.0

Geeft een lijst weer van de metrische gegevens over gebruik, geaggregeerd per pool met afzonderlijke tijdsintervallen, voor het opgegeven account.
Als u geen $filter component met inbegrip van een poolId opgeeft, bevat het antwoord alle pools die in het account aanwezig zijn in het tijdsbereik van de geretourneerde aggregatie-intervallen. Als u geen $filter component opgeeft, inclusief een startTime of endTime, worden deze filters standaard ingesteld op de begin- en eindtijden van het laatste aggregatie-interval dat momenteel beschikbaar is; Dat wil gezegd, alleen het laatste aggregatie-interval wordt geretourneerd.

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

URI-parameters

Name In Vereist Type Description
batchUrl
 path True

string

De basis-URL voor alle Azure Batch-serviceaanvragen.
api-version
 query True

string

Client-API-versie.
$filter
 query

string

Een OData-$filter-component. Zie https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metricsvoor meer informatie over het maken van dit filter.
endtime
 query

string

date-time

De laatste tijd van waaruit metrische gegevens moeten worden opgenomen. Dit moet ten minste twee uur vóór de huidige tijd zijn. Als deze standaardwaarde niet is opgegeven voor de eindtijd van het laatste aggregatie-interval dat momenteel beschikbaar is.
maxresults
 query

integer

int32

Het maximum aantal items dat moet worden geretourneerd in het antwoord. Er worden maximaal 1000 resultaten geretourneerd.
starttime
 query

string

date-time

De vroegste tijd van waaruit metrische gegevens moeten worden opgenomen. Dit moet ten minste twee en een half uur vóór de huidige tijd zijn. Als deze standaardinstelling niet is opgegeven voor de begintijd van het laatste aggregatie-interval dat momenteel beschikbaar is.
timeout
 query

integer

int32

De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt in plaats daarvan de standaardwaarde gebruikt.

Aanvraagkoptekst

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

Name Vereist Type Description
client-request-id

string

uuid

De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Of de server de clientaanvraag-id in het antwoord moet retourneren.
ocp-date

string

date-time-rfc1123

Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name Type Description
200 OK

PoolListUsageMetricsResult

Een antwoord met de lijst met poolgebruiksgegevens.

Kopteksten

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Pool list usage metrics

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
BatchError

Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
PoolListUsageMetricsResult

Het resultaat van een lijst met de metrische gebruiksgegevens voor een account.
PoolUsageMetrics

Metrische gegevens over gebruik voor een pool binnen een aggregatie-interval.

BatchError

Er is een foutbericht ontvangen van de Azure Batch-service.

Name Type Description
code

string

Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message

ErrorMessage

Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values

BatchErrorDetail[]

Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name Type Description
key

string

Een id die de betekenis van de eigenschap Waarde aangeeft.
value

string

De aanvullende informatie die is opgenomen in het foutbericht.

ErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name Type Description
lang

string

De taalcode van het foutbericht
value

string

De tekst van het bericht.

PoolListUsageMetricsResult

Het resultaat van een lijst met de metrische gebruiksgegevens voor een account.

Name Type Description
odata.nextLink

string

De URL voor het ophalen van de volgende set resultaten.
value

PoolUsageMetrics[]

De metrische gegevens van het poolgebruik.

PoolUsageMetrics

Metrische gegevens over gebruik voor een pool binnen een aggregatie-interval.

Name Type Description
endTime

string

De eindtijd van het aggregatie-interval waarop deze vermelding betrekking heeft.
poolId

string

De id van de pool waarvan de metrische gegevens worden geaggregeerd in deze vermelding.
startTime

string

De begintijd van het aggregatie-interval waarop deze vermelding betrekking heeft.
totalCoreHours

number

De totale kernuren die tijdens dit aggregatie-interval in de pool worden gebruikt.
vmSize

string

De grootte van virtuele machines in de pool. Alle VM's in een pool hebben dezelfde grootte.
Zie Een VM-grootte kiezen voor rekenknooppunten in een Azure Batch-pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes) voor informatie over de beschikbare grootten van virtuele machines in pools.