Freigeben über

Pool - List Usage Metrics

  • Referenz
Dienst:
Batch Service
API-Version:
2024-07-01.20.0

Listet die Nutzungsmetriken auf, aggregiert nach Pool über einzelne Zeitintervalle für das angegebene Konto.
Wenn Sie keine $filter Klausel einschließlich einer poolId angeben, enthält die Antwort alle Pools, die im Konto im Zeitraum der zurückgegebenen Aggregationsintervalle vorhanden sind. Wenn Sie keine $filter Klausel angeben, die eine startTime- oder EndTime-Klausel enthält, werden diese Filter standardmäßig auf die Start- und Endzeiten des letzten verfügbaren Aggregationsintervalls festgelegt. d. h., nur das letzte Aggregationsintervall wird zurückgegeben.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
batchUrl
 path True

string

Die Basis-URL für alle Azure Batch-Dienstanforderungen.
api-version
 query True

string

Client-API-Version.
$filter
 query

string

Eine OData-$filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime
 query

string

date-time

Die neueste Zeit, aus der Metriken einbezogen werden sollen. Dies muss mindestens zwei Stunden vor der aktuellen Uhrzeit betragen. Wenn diese Standardeinstellung nicht auf die Endzeit des letzten verfügbaren Aggregationsintervalls festgelegt ist.
maxresults
 query

integer

int32

Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Es werden maximal 1000 Ergebnisse zurückgegeben.
starttime
 query

string

date-time

Die früheste Zeit, aus der Metriken einbezogen werden sollen. Dies muss mindestens zweieinhalb Stunden vor der aktuellen Uhrzeit betragen. Wenn diese Standardeinstellung nicht auf die Startzeit des letzten verfügbaren Aggregationsintervalls festgelegt ist.
timeout
 query

integer

int32

Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

Anforderungsheader

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

Name Erforderlich Typ Beschreibung
client-request-id

string

uuid

Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
ocp-date

string

date-time-rfc1123

Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Antworten

Name Typ Beschreibung
200 OK

PoolListUsageMetricsResult

Eine Antwort, die die Liste der Poolnutzungsdetails enthält.

Header

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

BatchError

Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

Pool list usage metrics

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
PoolListUsageMetricsResult

Das Ergebnis einer Auflistung der Nutzungsmetriken für ein Konto.
PoolUsageMetrics

Verwendungsmetriken für einen Pool über ein Aggregationsintervall hinweg.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message

ErrorMessage

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values

BatchErrorDetail[]

Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.

Name Typ Beschreibung
key

string

Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value

string

Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.

Name Typ Beschreibung
lang

string

Der Sprachcode der Fehlermeldung
value

string

Der Text der Nachricht.

PoolListUsageMetricsResult

Das Ergebnis einer Auflistung der Nutzungsmetriken für ein Konto.

Name Typ Beschreibung
odata.nextLink

string

Die URL, um den nächsten Satz von Ergebnissen abzurufen.
value

PoolUsageMetrics[]

Die Metriken für die Poolnutzung.

PoolUsageMetrics

Verwendungsmetriken für einen Pool über ein Aggregationsintervall hinweg.

Name Typ Beschreibung
endTime

string

Die Endzeit des aggregationsintervalls, das von diesem Eintrag abgedeckt wird.
poolId

string

Die ID des Pools, deren Metriken in diesem Eintrag aggregiert werden.
startTime

string

Die Startzeit des aggregationsintervalls, das von diesem Eintrag abgedeckt wird.
totalCoreHours

number

Die gesamten Kernstunden, die während dieses Aggregationsintervalls im Pool verwendet werden.
vmSize

string

Die Größe virtueller Computer im Pool. Alle virtuellen Computer in einem Pool sind die gleiche Größe.
Informationen zu verfügbaren Größen virtueller Computer in Pools finden Sie unter Auswählen einer VM-Größe für Computeknoten in einem Azure-Batchpool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).