Pool - List Usage Metrics

Usługa:

Batch Service

Wersja interfejsu API:

2024-07-01.20.0

Wyświetla listę metryk użycia, agregowanych według puli w poszczególnych interwałach czasu dla określonego konta.
Jeśli nie określisz klauzuli $filter zawierającej identyfikator poolId, odpowiedź zawiera wszystkie pule, które istniały w ramach konta w zakresie czasu zwracanych interwałów agregacji. Jeśli nie określisz klauzuli $filter, w tym parametru startTime lub endTime, te filtry są domyślne dla czasów rozpoczęcia i zakończenia ostatniego dostępnego interwału agregacji; oznacza to, że zwracany jest tylko ostatni interwał agregacji.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań usługi Azure Batch.
api-version	query	True	string	Wersja interfejsu API klienta.
$filter	query		string	Klauzula OData $filter. Aby uzyskać więcej informacji na temat konstruowania tego filtru, zobacz https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime	query		string date-time	Czas najnowszy, od którego mają być uwzględniane metryki. Musi to być co najmniej dwie godziny przed bieżącą godziną. Jeśli ta wartość domyślna nie zostanie określona, zostanie ustawiona na czas zakończenia ostatniego dostępnego interwału agregacji.
maxresults	query		integer int32	Maksymalna liczba elementów do zwrócenia w odpowiedzi. Zostanie zwróconych maksymalnie 1000 wyników.
starttime	query		string date-time	Najwcześniejszy czas, od którego należy uwzględnić metryki. Musi to być co najmniej dwie i pół godziny przed bieżącą godziną. Jeśli ta wartość domyślna nie zostanie określona, zostanie ustawiona godzina rozpoczęcia ostatniego dostępnego interwału agregacji.
timeout	query		integer int32	Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta wartość domyślna.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
client-request-id		string uuid	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Czy serwer powinien zwrócić identyfikator żądania klienta w odpowiedzi.
ocp-date		string date-time-rfc1123	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PoolListUsageMetricsResult	Odpowiedź zawierająca listę szczegółów użycia puli. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra OAuth 2.0 — przepływ kodu uwierzytelniania

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Typ: apiKey
W: header

Przykłady

Pool list usage metrics

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
BatchError	Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
PoolListUsageMetricsResult	Wynik wyświetlania listy metryk użycia dla konta.
PoolUsageMetrics	Metryki użycia dla puli w interwale agregacji.

BatchError

Odebrano odpowiedź o błędzie z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.

PoolListUsageMetricsResult

Wynik wyświetlania listy metryk użycia dla konta.

Nazwa	Typ	Opis
odata.nextLink	string	Adres URL umożliwiający uzyskanie następnego zestawu wyników.
value	PoolUsageMetrics[]	Dane metryk użycia puli.

PoolUsageMetrics

Metryki użycia dla puli w interwale agregacji.

Nazwa	Typ	Opis
endTime	string	Godzina zakończenia interwału agregacji objętego tym wpisem.
poolId	string	Identyfikator puli, której metryki są agregowane w tym wpisie.
startTime	string	Godzina rozpoczęcia interwału agregacji objętego tym wpisem.
totalCoreHours	number	Łączna liczba godzin rdzeni używanych w puli w tym interwale agregacji.
vmSize	string	Rozmiar maszyn wirtualnych w puli. Wszystkie maszyny wirtualne w puli mają taki sam rozmiar. Aby uzyskać informacje o dostępnych rozmiarach maszyn wirtualnych w pulach, zobacz Wybieranie rozmiaru maszyny wirtualnej dla węzłów obliczeniowych w puli usługi Azure Batch (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).