Pools - List Pool Node Counts

Služba:: Batch Service

Verze rozhraní API:: 2025-06-01

Získá počet výpočetních uzlů v každém stavu seskupené podle fondu. Všimněte si, že vrácená čísla nemusí být vždy aktuální. Pokud potřebujete přesné počty uzlů, použijte dotaz seznamu.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Koncový bod účtu Batch (například: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$filter	query		string	Klauzule $filter OData. Pro více informací o konstrukci tohoto filtru viz https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Maximální počet položek, které se mají vrátit v odpovědi. Maximálně 1000 žádostí lze vrátit.
timeOut	query		integer (int32)	Maximální doba, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.".

Hlavička požadavku

Name	Typ	Description
client-request-id	string	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.
ocp-date	string (date-time-rfc7231)	Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.

Odpovědi

Name	Typ	Description
200 OK	BatchPoolNodeCountsListResult	Požadavek byl úspěšný. Hlavičky ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Neočekávaná chybová odpověď

Name

Typ

Description

200 OK

BatchPoolNodeCountsListResult

Požadavek byl úspěšný.

Hlavičky

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Neočekávaná chybová odpověď

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

Name	Description
https://batch.core.windows.net//.default

Příklady

NodeCountsPayload

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
      }
    }
  ]
}

Definice

Name	Description
BatchError	Odpověď na chybu přijatá ze služby Azure Batch
BatchErrorDetail	Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch
BatchErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
BatchNodeCounts	Počet výpočetních uzlů v každém stavu výpočetního uzlu.
BatchPoolNodeCounts	Počet výpočetních uzlů v jednotlivých stavech fondu.
BatchPoolNodeCountsListResult	Výsledek výpisu počtu výpočetních uzlů v účtu.

BatchError

Objekt

Odpověď na chybu přijatá ze služby Azure Batch

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message	BatchErrorMessage	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Objekt

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

Name	Typ	Description
key	string	Identifikátor určující význam vlastnosti Value.
value	string	Další informace zahrnuté v odpovědi na chybu.

BatchErrorMessage

Objekt

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

Name	Typ	Description
lang	string	Jazykový kód chybové zprávy.
value	string	Text zprávy.

BatchNodeCounts

Objekt

Počet výpočetních uzlů v každém stavu výpočetního uzlu.

Name	Typ	Description
creating	integer (int32)	Počet výpočetních uzlů ve stavu vytvářejícím výpočetu.
deallocated	integer (int32)	Počet výpočetních uzlů ve stavu dealokace.
deallocating	integer (int32)	Počet výpočetních uzlů ve stavu dealokace.
idle	integer (int32)	Počet výpočetních uzlů ve stavu nečinnosti.
leavingPool	integer (int32)	Počet Compute Nodes ve stavu leaveingPool.
offline	integer (int32)	Počet výpočetních uzlů v offline stavu.
preempted	integer (int32)	Počet výpočetních uzlů v preempted stavu.
rebooting	integer (int32)	Počet výpočetních uzlů ve stavu restartu.
reimaging	integer (int32)	Počet výpočetních uzlů ve stavu reimagingu.
running	integer (int32)	Počet výpočetních uzlů v běžícím stavu.
startTaskFailed	integer (int32)	Počet Compute uzlů ve stavu startTaskFailed.
starting	integer (int32)	Počet výpočetních uzlů v počátečním stavu.
total	integer (int32)	Celkový počet výpočetních uzlů.
unknown	integer (int32)	Počet výpočetních uzlů v neznámém stavu.
unusable	integer (int32)	Počet výpočetních uzlů v nepoužitelném stavu.
upgradingOS	integer (int32)	Počet Compute Nodes ve stavu upgradingOS.
waitingForStartTask	integer (int32)	Počet Compute uzlů ve stavu waitingForStartTask.

BatchPoolNodeCounts

Objekt

Počet výpočetních uzlů v jednotlivých stavech fondu.

Name	Typ	Description
dedicated	BatchNodeCounts	Počet vyhrazených výpočetních uzlů v každém stavu.
lowPriority	BatchNodeCounts	Počet spot/nízkoprioritních výpočetních uzlů v každém stavu.
poolId	string	ID Poolu.

BatchPoolNodeCountsListResult

Objekt

Výsledek výpisu počtu výpočetních uzlů v účtu.

Name	Typ	Description
odata.nextLink	string (uri)	Adresa URL pro získání další sady výsledků.
value	BatchPoolNodeCounts[]	Seznam počtů výpočetních uzlů podle Poolu.