Account - List Pool Node Counts

Reference

Service:: Batch Service

API Version:: 2023-11-01.18.0

Získá počet výpočetních uzlů v každém stavu seskupených 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 na seznam.

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 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 klientského rozhraní API.
$filter	query		string	Klauzule $filter OData. Další informace o vytváření tohoto filtru najdete v tématu https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer int32	Maximální počet položek, které se mají vrátit v odpovědi.
timeout	query		integer int32	Maximální čas, který může server strávit zpracováním požadavku, v sekundách. Výchozí hodnota je 30 sekund.

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 ozdob, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Jestli má server v odpovědi vrátit client-request-id.
ocp-date	string date-time-rfc1123	Čas, kdy byla žádost vystavena. Klientské knihovny obvykle tuto možnost nastaví na aktuální systémový čas. pokud přímo voláte rozhraní REST API, nastavte ho explicitně.

Odpovědi

Name	Typ	Description
200 OK	PoolNodeCountsListResult	Odpověď obsahuje počet výpočetních uzlů v jednotlivých stavech výpočetních uzlů seskupených podle fondu. Headers 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ů v jednotlivých stavech výpočetních uzlů seskupených podle fondu.

Headers

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

Other Status Codes

BatchError

Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok kódu ověřování OAuth 2.0

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

Scopes

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

Authorization

Type: apiKey
In: header

Příklady

NodeCountsPayload

Sample Request

HTTP

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
      }
    }
  ]
}

Definice

Name	Description
BatchError	Ze služby Azure Batch byla přijata chybová odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.
ErrorMessage	Chybová zpráva přijatá v Azure Batch odpověď na chybu.
NodeCounts	Počet výpočetních uzlů v jednotlivých stavech výpočetních uzlů.
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

Ze služby Azure Batch byla přijata chybová odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány 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

Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.

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

ErrorMessage

Chybová zpráva přijatá v Azure Batch odpověď na chybu.

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

NodeCounts

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

Name	Typ	Description
creating	integer	Počet výpočetních uzlů ve stavu vytváření.
idle	integer	Počet výpočetních uzlů ve stavu nečinnosti.
leavingPool	integer	Počet výpočetních uzlů ve stavu leavingPool.
offline	integer	Počet výpočetních uzlů v offline stavu.
preempted	integer	Počet výpočetních uzlů v předem připraveném stavu.
rebooting	integer	Počet výpočetních uzlů ve stavu restartování.
reimaging	integer	Počet výpočetních uzlů v reimagingovém stavu.
running	integer	Počet výpočetních uzlů ve spuštěném stavu.
startTaskFailed	integer	Počet výpočetních uzlů ve stavu startTaskFailed.
starting	integer	Počet výpočetních uzlů v počátečním stavu.
total	integer	Celkový počet výpočetních uzlů.
unknown	integer	Počet výpočetních uzlů v neznámém stavu.
unusable	integer	Počet výpočetních uzlů v nepoužitelném stavu.
waitingForStartTask	integer	Počet výpočetních uzlů ve stavu waitingForStartTask.

PoolNodeCounts

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 každém stavu.
lowPriority	NodeCounts	Počet spotových výpočetních uzlů s nízkou prioritou v jednotlivých stavech.
poolId	string	ID fondu.

PoolNodeCountsListResult

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.

Account - List Pool Node Counts

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Authorization

Příklady

NodeCountsPayload

Sample Request

Sample Response

Definice

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Další materiály