Pools - List Pool Node Counts

Usługa:: Batch Service

Wersja interfejsu API:: 2025-06-01

Pobiera liczbę węzłów obliczeniowych w każdym stanie pogrupowanych według puli. Zwróć uwagę, że zwracane liczby mogą nie zawsze być aktualne. Jeśli potrzebujesz dokładnych liczb węzłów, użyj zapytania listy.

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

Z parametrami opcjonalnymi:

GET {endpoint}/nodecounts?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$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-support-images
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.
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	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	BatchPoolNodeCountsListResult	Żą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.

Nazwa

Typ

Opis

200 OK

BatchPoolNodeCountsListResult

Żą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

NodeCountsPayload

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 2,
        "starting": 1,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 1,
        "leavingPool": 0,
        "offline": 3,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 4
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 5,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 4,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 11
      }
    }
  ]
}

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.
BatchNodeCounts	Liczba węzłów obliczeniowych w każdym stanie węzła obliczeniowego.
BatchPoolNodeCounts	Liczba węzłów obliczeniowych w każdym stanie dla puli.
BatchPoolNodeCountsListResult	Wynik wyświetlania liczby węzłów obliczeniowych w ramach konta.

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.

BatchNodeCounts

Objekt

Liczba węzłów obliczeniowych w każdym stanie węzła obliczeniowego.

Nazwa	Typ	Opis
creating	integer (int32)	Liczba węzłów obliczeniowych w stanie tworzenia.
deallocated	integer (int32)	Liczba węzłów obliczeniowych w stanie wykluczonym.
deallocating	integer (int32)	Liczba węzłów obliczeniowych w stanie dealokacji.
idle	integer (int32)	Liczba węzłów obliczeniowych w stanie bezczynności.
leavingPool	integer (int32)	Liczba węzłów obliczeniowych w stanie leaveingPool.
offline	integer (int32)	Liczba węzłów obliczeniowych w stanie offline.
preempted	integer (int32)	Liczba węzłów obliczeniowych w stanie wyłączonym.
rebooting	integer (int32)	Liczba węzłów obliczeniowych w stanie restartu.
reimaging	integer (int32)	Liczba węzłów obliczeniowych w stanie reimagingowania.
running	integer (int32)	Liczba węzłów obliczeniowych w stanie bieżącym.
startTaskFailed	integer (int32)	Liczba węzłów obliczeniowych w stanie startTaskFailed.
starting	integer (int32)	Liczba węzłów obliczeniowych w stanie początkowym.
total	integer (int32)	Całkowita liczba węzłów obliczeniowych.
unknown	integer (int32)	Liczba węzłów obliczeniowych w nieznanym stanie.
unusable	integer (int32)	Liczba węzłów obliczeniowych w stanie nieużytecznym.
upgradingOS	integer (int32)	Liczba węzłów obliczeniowych w stanie upgradingOS.
waitingForStartTask	integer (int32)	Liczba węzłów obliczeniowych w stanie waitingForStartTask.

BatchPoolNodeCounts

Objekt

Liczba węzłów obliczeniowych w każdym stanie dla puli.

Nazwa	Typ	Opis
dedicated	BatchNodeCounts	Liczba dedykowanych węzłów obliczeniowych w każdym stanie.
lowPriority	BatchNodeCounts	Liczba węzłów obliczeniowych Spot/Niskiego Priorytetu w każdym stanie.
poolId	string	Identyfikacja Pool.

BatchPoolNodeCountsListResult

Objekt

Wynik wyświetlania liczby węzłów obliczeniowych w ramach konta.

Nazwa	Typ	Opis
odata.nextLink	string (uri)	Adres URL, aby uzyskać następny zestaw wyników.
value	BatchPoolNodeCounts[]	Lista liczb węzłów obliczeniowych według puli.

Udostępnij przez

Pools - List Pool Node Counts

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

OAuth2Auth

Zakresy

Przykłady

NodeCountsPayload

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeCounts

BatchPoolNodeCounts

BatchPoolNodeCountsListResult