Account - List Pool Node Counts

  • Odwołanie
Service:
Batch Service
API Version:
2023-11-01.18.0

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 {batchUrl}/nodecounts?api-version=2023-11-01.18.0
With optional parameters: 
GET {batchUrl}/nodecounts?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
batchUrl
 path True

string

Podstawowy adres URL dla wszystkich żądań obsł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://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.
maxresults
 query

integer

int32

Maksymalna liczba elementów do zwrócenia w odpowiedzi.
timeout
 query

integer

int32

Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund.

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, takich jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Określa, czy serwer powinien zwrócić wartość client-request-id 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

PoolNodeCountsListResult

Odpowiedź zawiera liczbę węzłów obliczeniowych w każdym stanie węzła obliczeniowego pogrupowanych według puli.

Headers

  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Błąd usługi Batch.

Zabezpieczenia

azure_auth

przepływ kodu uwierzytelniania OAuth 2.0 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation Personifikuj konto użytkownika

Authorization

Type: apiKey
In: header

Przykłady

NodeCountsPayload

Sample Request

GET account.region.batch.azure.com/nodecounts?api-version=2023-11-01.18.0

Sample Response

Status code:
200 
{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 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,
        "total": 0
      },
      "lowPriority": {
        "creating": 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,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 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,
        "total": 4
      },
      "lowPriority": {
        "creating": 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,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 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,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 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 Azure Batch.
ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.
NodeCounts

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

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

Wynik wyświetlania liczby węzłów obliczeniowych na koncie.

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 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 Azure Batch błędu.

Nazwa Typ Opis
lang

string

Kod języka komunikatu o błędzie
value

string

Tekst wiadomości.

NodeCounts

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

Nazwa Typ Opis
creating

integer

Liczba węzłów obliczeniowych w stanie tworzenia.
idle

integer

Liczba węzłów obliczeniowych w stanie bezczynności.
leavingPool

integer

Liczba węzłów obliczeniowych w stanie opuszczania puli.
offline

integer

Liczba węzłów obliczeniowych w stanie offline.
preempted

integer

Liczba węzłów obliczeniowych w stanie wywłaszczonym.
rebooting

integer

Liczba węzłów obliczeniowych w stanie ponownego uruchamiania.
reimaging

integer

Liczba węzłów obliczeniowych w stanie ponownego przetwarzania.
running

integer

Liczba węzłów obliczeniowych w stanie uruchomienia.
startTaskFailed

integer

Liczba węzłów obliczeniowych w stanie startTaskFailed.
starting

integer

Liczba węzłów obliczeniowych w stanie początkowym.
total

integer

Całkowita liczba węzłów obliczeniowych.
unknown

integer

Liczba węzłów obliczeniowych w nieznanym stanie.
unusable

integer

Liczba węzłów obliczeniowych w stanie bezużytecznym.
waitingForStartTask

integer

Liczba węzłów obliczeniowych w stanieaitingForStartTask.

PoolNodeCounts

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

Nazwa Typ Opis
dedicated

NodeCounts

Liczba dedykowanych węzłów obliczeniowych w każdym stanie.
lowPriority

NodeCounts

Liczba węzłów obliczeniowych typu spot/low-priority w każdym stanie.
poolId

string

Identyfikator puli.

PoolNodeCountsListResult

Wynik wyświetlania liczby węzłów obliczeniowych na koncie.

Nazwa Typ Opis
odata.nextLink

string

Adres URL umożliwiający uzyskanie następnego zestawu wyników.
value

PoolNodeCounts[]

Lista węzłów obliczeniowych według puli.