Account - List Pool Node Counts

Tjänst:

Batch Service

API-version:

2024-07-01.20.0

Hämtar antalet beräkningsnoder i varje tillstånd, grupperat efter pool. Observera att de returnerade talen kanske inte alltid är uppdaterade. Om du behöver exakta nodantal använder du en listfråga.

GET {batchUrl}/nodecounts?api-version=2024-07-01.20.0

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch-tjänstbegäranden.
api-version	query	True	string	Klient-API-version.
$filter	query		string	En OData-$filter-sats. Mer information om hur du skapar det här filtret finns i https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer (int32) minimum: 1 maximum: 10	Det maximala antalet objekt som ska returneras i svaret.
timeout	query		integer (int32)	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet i stället.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string (uuid)	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string (date-time-rfc1123)	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt.

Svar

Name	Typ	Description
200 OK	PoolNodeCountsListResult	Svaret innehåller antalet beräkningsnoder i varje beräkningsnodtillstånd, grupperat efter pool. Sidhuvuden client-request-id: string request-id: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

NodeCountsPayload

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch-felsvar.
NodeCounts	Antalet beräkningsnoder i varje beräkningsnodtillstånd.
PoolNodeCounts	Antalet beräkningsnoder i varje tillstånd för en pool.
PoolNodeCountsListResult	Resultatet av att lista antalet beräkningsnoder i kontot.

BatchError

Objekt

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Objekt

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

ErrorMessage

Objekt

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

NodeCounts

Objekt

Antalet beräkningsnoder i varje beräkningsnodtillstånd.

Name	Typ	Description
creating	integer (int32)	Antalet beräkningsnoder i skapandetillståndet.
deallocated	integer (int32)	Antalet beräkningsnoder i frigjort tillstånd.
deallocating	integer (int32)	Antalet beräkningsnoder i frigöringstillståndet.
idle	integer (int32)	Antalet beräkningsnoder i inaktivt tillstånd.
leavingPool	integer (int32)	Antalet beräkningsnoder i tillståndet leavingPool.
offline	integer (int32)	Antalet beräkningsnoder i offlineläge.
preempted	integer (int32)	Antalet beräkningsnoder i förinställt tillstånd.
rebooting	integer (int32)	Antalet beräkningsnoder i omstartstillståndet.
reimaging	integer (int32)	Antalet beräkningsnoder i återimeringstillståndet.
running	integer (int32)	Antalet beräkningsnoder i körningstillståndet.
startTaskFailed	integer (int32)	Antalet beräkningsnoder i tillståndet startTaskFailed.
starting	integer (int32)	Antalet beräkningsnoder i starttillståndet.
total	integer (int32)	Det totala antalet beräkningsnoder.
unknown	integer (int32)	Antalet beräkningsnoder i okänt tillstånd.
unusable	integer (int32)	Antalet beräkningsnoder i oanvändbart tillstånd.
upgradingOS	integer (int32)	Antalet beräkningsnoder i uppgraderingstillståndet.
waitingForStartTask	integer (int32)	Antalet beräkningsnoder i väntelägeForStartTask.

PoolNodeCounts

Objekt

Antalet beräkningsnoder i varje tillstånd för en pool.

Name	Typ	Description
dedicated	NodeCounts	Antalet dedikerade beräkningsnoder i varje tillstånd.
lowPriority	NodeCounts	Antalet beräkningsnoder med oanvänd kapacitet/låg prioritet i varje tillstånd.
poolId	string	ID:t för poolen.

PoolNodeCountsListResult

Objekt

Resultatet av att lista antalet beräkningsnoder i kontot.

Name	Typ	Description
odata.nextLink	string	URL:en för att hämta nästa uppsättning resultat.
value	PoolNodeCounts[]	En lista över antal beräkningsnoder per pool.