Pools - List Pool Usage Metrics

Usługa:

Batch Service

Wersja interfejsu API:

2025-06-01

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 {endpoint}/poolusagemetrics?api-version=2025-06-01

Z parametrami opcjonalnymi:

GET {endpoint}/poolusagemetrics?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&startTime={startTime}&endtime={endtime}&$filter={$filter}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Punkt końcowy konta usługi Batch (na przykład: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	Klauzula OData $filter. Więcej informacji o konstrukcji tego filtra można znaleźć w .https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics
endtime	query		string (date-time)	Najnowszy moment, z którego warto uwzględnić wskaźniki. To musi być co najmniej dwie godziny przed aktualną godziną. Jeśli nie jest to określone, domyślnie jest to czas końcowy ostatniego dostępnego obecnie interwału agregacji.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Maksymalna liczba elementów do zwrócenia w odpowiedzi. Maksymalnie można zwrócić 1000 wniosków.
startTime	query		string (date-time)	Najwcześniejszy czas, od którego można uwzględnić metryki. Musi to być co najmniej dwie i pół godziny przed aktualnym czasem. Jeśli nie jest to określone, domyślnie jest to czas rozpoczęcia ostatniego dostępnego obecnie 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 domyślna wersja domyślna.".

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
client-request-id		string	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-rfc7231)	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	BatchPoolListUsageMetricsResult	Żądanie zakończyło się pomyślnie. Nagłówki ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

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

Zakresy

Nazwa	Opis
https://batch.core.windows.net//.default

Przykłady

Pool list usage metrics

Przykładowe żądanie

HTTP

GET {endpoint}/poolusagemetrics?api-version=2025-06-01

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.
BatchErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
BatchPoolListUsageMetricsResult	Wynik wyświetlania listy metryk użycia dla konta.
BatchPoolUsageMetrics	Metryki użycia dla puli w interwale agregacji.

BatchError

Objekt

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	BatchErrorMessage	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

Objekt

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.

BatchErrorMessage

Objekt

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

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

BatchPoolListUsageMetricsResult

Objekt

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

Nazwa	Typ	Opis
odata.nextLink	string (uri)	Adres URL, aby uzyskać następny zestaw wyników.
value	BatchPoolUsageMetrics[]	Dane metryk wykorzystania puli.

BatchPoolUsageMetrics

Objekt

Metryki użycia dla puli w interwale agregacji.

Nazwa	Typ	Opis
endTime	string (date-time)	Czas końcowy interwału agregacji objęty tym wpisem.
poolId	string	ID puli, której metryki są agregowane w tym wpisie.
startTime	string (date-time)	Czas rozpoczęcia interwału agregacji objętego tym wpisem.
totalCoreHours	number (float)	Łączna liczba godzin podstawowych użytych w Poolu podczas tego okresu agregacji.
vmSize	string	Rozmiar maszyn wirtualnych w puli. Wszystkie maszyny wirtualne w Poolu mają ten 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 Azure Batch (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).