Pools - List Pool Node Counts

Service:: Batch Service

API-versie:: 2025-06-01

Hiermee haalt u het aantal rekenknooppunten in elke status op, gegroepeerd op pool. Houd er rekening mee dat de geretourneerde getallen mogelijk niet altijd up-to-date zijn. Als u exact aantal knooppunten nodig hebt, gebruikt u een lijstquery.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	Batch-accounteindpunt (bijvoorbeeld: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	Een OData-$filter-component. Voor meer informatie over het construeren van dit filter, zie https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Het maximum aantal items dat moet worden geretourneerd in het antwoord. Maximaal 1000 aanvragen kunnen worden teruggestuurd.
timeOut	query		integer (int32)	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt de standaard in plaats daarvan gebruikt."

Aanvraagkoptekst

Name	Type	Description
client-request-id	string	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Of de server de clientaanvraag-id in het antwoord moet retourneren.
ocp-date	string (date-time-rfc7231)	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name	Type	Description
200 OK	BatchPoolNodeCountsListResult	De aanvraag is voltooid. Kopteksten ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Een onverwachte foutreactie.

Name

Type

Description

200 OK

BatchPoolNodeCountsListResult

De aanvraag is voltooid.

Kopteksten

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

Other Status Codes

BatchError

Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

NodeCountsPayload

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
BatchError	Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
BatchErrorMessage	Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
BatchNodeCounts	Het aantal rekenknooppunten in elke status van het rekenknooppunt.
BatchPoolNodeCounts	Het aantal rekenknooppunten in elke status voor een pool.
BatchPoolNodeCountsListResult	Het resultaat van het weergeven van het aantal rekenknooppunten in het account.

BatchError

Object

Er is een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	BatchErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Object

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Waarde aangeeft.
value	string	De aanvullende informatie die is opgenomen in het foutbericht.

BatchErrorMessage

Object

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name	Type	Description
lang	string	De taalcode van het foutbericht.
value	string	De tekst van het bericht.

BatchNodeCounts

Object

Het aantal rekenknooppunten in elke status van het rekenknooppunt.

Name	Type	Description
creating	integer (int32)	Het aantal rekenknooppunten in de aanmakende toestand.
deallocated	integer (int32)	Het aantal Compute Nodes in de niet-toegewezen toestand.
deallocating	integer (int32)	Het aantal Compute Nodes in de dealloceringstoestand.
idle	integer (int32)	Het aantal rekenknooppunten in de inactieve toestand.
leavingPool	integer (int32)	Het aantal Compute Nodes in de leaveingPool-toestand.
offline	integer (int32)	Het aantal rekenknooppunten in de offline toestand.
preempted	integer (int32)	Het aantal rekenknopen in de preemptietoestand.
rebooting	integer (int32)	Het aantal Compute Nodes in de herstartfase.
reimaging	integer (int32)	Het aantal Compute Nodes in de reimagin-toestand.
running	integer (int32)	Het aantal Compute Nodes in de draaiende toestand.
startTaskFailed	integer (int32)	Het aantal Compute Nodes in de startTaskFailed-toestand.
starting	integer (int32)	Het aantal Compute Nodes in de starttoestand.
total	integer (int32)	Het totale aantal rekenknooppunten.
unknown	integer (int32)	Het aantal Compute Nodes in de onbekende toestand.
unusable	integer (int32)	Het aantal rekenknooppunten in de onbruikbare toestand.
upgradingOS	integer (int32)	Het aantal Compute Nodes in de upgradingOS-toestand.
waitingForStartTask	integer (int32)	Het aantal Compute Nodes in de waitingForStartTask-toestand.

BatchPoolNodeCounts

Object

Het aantal rekenknooppunten in elke status voor een pool.

Name	Type	Description
dedicated	BatchNodeCounts	Het aantal toegewijde Compute Nodes in elke toestand.
lowPriority	BatchNodeCounts	Het aantal Spot/Low-priority Compute Nodes in elke toestand.
poolId	string	De ID van het zwembad.

BatchPoolNodeCountsListResult

Object

Het resultaat van het weergeven van het aantal rekenknooppunten in het account.

Name	Type	Description
odata.nextLink	string (uri)	De URL om de volgende reeks resultaten te krijgen.
value	BatchPoolNodeCounts[]	Een lijst van Compute Node-tellingen per pool.

Delen via

Pools - List Pool Node Counts

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

OAuth2Auth

Bereiken

Voorbeelden

NodeCountsPayload

Voorbeeldaanvraag

Voorbeeldrespons

Definities

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeCounts

BatchPoolNodeCounts

BatchPoolNodeCountsListResult