Account - List Pool Node Counts

Reference

Služba:: Batch Service

Verze rozhraní API:: 2024-07-01.20.0

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 {batchUrl}/nodecounts?api-version=2024-07-01.20.0

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky služby Azure Batch.
api-version	query	True	string	Verze rozhraní API klienta.
$filter	query		string	Klauzule $filter OData. Další informace o vytváření tohoto filtru naleznete v tématu https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer (int32) minimum: 1 maximum: 10	Maximální počet položek, které se mají vrátit v odpovědi.
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

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

Name	Typ	Description
client-request-id	string (uuid)	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-rfc1123)	Č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	PoolNodeCountsListResult	Odpověď obsahuje počet výpočetních uzlů ve všech stavech výpočetních uzlů seskupených podle fondu. Hlavičky client-request-id: string request-id: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Name

Typ

Description

200 OK

PoolNodeCountsListResult

Odpověď obsahuje počet výpočetních uzlů ve všech stavech výpočetních uzlů seskupených podle fondu.

Hlavičky

client-request-id: string
request-id: string

Other Status Codes

BatchError

Chyba ze služby Batch.

Zabezpečení

azure_auth

Tok ověřovacího kódu Microsoft Entra OAuth 2.0

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

Rozsahy

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Typ: apiKey
V: header

Příklady

NodeCountsPayload

Ukázkový požadavek

HTTP

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

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
ErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
NodeCounts	Počet výpočetních uzlů v každém stavu výpočetního uzlu.
PoolNodeCounts	Počet výpočetních uzlů v jednotlivých stavech fondu.
PoolNodeCountsListResult	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	ErrorMessage	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.

ErrorMessage

Objekt

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

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy.

NodeCounts

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áření
deallocated	integer (int32)	Počet výpočetních uzlů v uvolněném stavu.
deallocating	integer (int32)	Počet výpočetních uzlů v uvolněném stavu.
idle	integer (int32)	Počet výpočetních uzlů ve stavu nečinnosti.
leavingPool	integer (int32)	Početvýpočetních
offline	integer (int32)	Počet výpočetních uzlů v offline stavu.
preempted	integer (int32)	Počet výpočetních uzlů v předem připraveném stavu.
rebooting	integer (int32)	Počet výpočetních uzlů ve stavu restartování
reimaging	integer (int32)	Počet výpočetních uzlů v reimaging stavu.
running	integer (int32)	Počet výpočetníchuzlůch
startTaskFailed	integer (int32)	Počet výpočetních uzlů ve stavu startTaskFailed.
starting	integer (int32)	Počet výpočetních uzlů ve výchozím stavu.
total	integer (int32)	Celkový počet výpočetníchuzlůch
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 výpočetníchuzlůch
waitingForStartTask	integer (int32)	Počet výpočetníchuzlůchch

PoolNodeCounts

Objekt

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

Name	Typ	Description
dedicated	NodeCounts	Počet vyhrazených výpočetních uzlů v jednotlivých stavech.
lowPriority	NodeCounts	Počet výpočetních uzlů s nízkou prioritou ve všech stavech.
poolId	string	ID fondu.

PoolNodeCountsListResult

Objekt

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

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

Sdílet prostřednictvím

Account - List Pool Node Counts

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Authorization

Příklady

NodeCountsPayload

Ukázkový požadavek

Ukázková odpověď

Definice

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Další materiály