Pools - List Pool Node Counts

Dienst:: Batch Service

API-Version:: 2025-06-01

Ruft die Anzahl der Computeknoten in jedem Zustand ab, gruppiert nach Pool. Beachten Sie, dass die zurückgegebenen Zahlen möglicherweise nicht immer auf dem neuesten Stand sind. Wenn Sie genaue Knotenanzahl benötigen, verwenden Sie eine Listenabfrage.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Batchkontoendpunkt (z. B. https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$filter	query		string	Eine OData-$filter-Klausel. Weitere Informationen zur Konstruktion dieses Filters finden Sie unter https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Maximal 1000 Anträge können zurückgeschickt werden.
timeOut	query		integer (int32)	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Ist der Wert größer als 30, wird stattdessen der Standard verwendet."

Anforderungsheader

Name	Typ	Beschreibung
client-request-id	string	Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
ocp-date	string (date-time-rfc7231)	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Antworten

Name	Typ	Beschreibung
200 OK	BatchPoolNodeCountsListResult	Die Anforderung ist erfolgreich. Header ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

BatchPoolNodeCountsListResult

Die Anforderung ist erfolgreich.

Header

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

Other Status Codes

BatchError

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

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

Beispiele

NodeCountsPayload

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
BatchErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
BatchNodeCounts	Die Anzahl der Computeknoten in jedem Computeknotenstatus.
BatchPoolNodeCounts	Die Anzahl der Computeknoten in jedem Zustand für einen Pool.
BatchPoolNodeCountsListResult	Das Ergebnis der Auflistung der Computeknotenanzahl im Konto.

BatchError

Objekt

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message	BatchErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

Objekt

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.

Name	Typ	Beschreibung
key	string	Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value	string	Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

BatchErrorMessage

Objekt

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung.
value	string	Der Text der Nachricht.

BatchNodeCounts

Objekt

Die Anzahl der Computeknoten in jedem Computeknotenstatus.

Name	Typ	Beschreibung
creating	integer (int32)	Die Anzahl der Compute-Knoten im Erstellungszustand.
deallocated	integer (int32)	Die Anzahl der Compute-Knoten im dezugeordneten Zustand.
deallocating	integer (int32)	Die Anzahl der Compute-Knoten im Deallocing-Zustand.
idle	integer (int32)	Die Anzahl der Rechenknoten im Leerzustand.
leavingPool	integer (int32)	Die Anzahl der Compute Nodes im leaveingPool-Zustand.
offline	integer (int32)	Die Anzahl der Rechenknoten im Offline-Zustand.
preempted	integer (int32)	Die Anzahl der Compute Nodes im präempierten Zustand.
rebooting	integer (int32)	Die Anzahl der Compute-Knoten im Neustart-Zustand.
reimaging	integer (int32)	Die Anzahl der Rechenknoten im Reimaging-Zustand.
running	integer (int32)	Die Anzahl der Rechenknoten im laufenden Zustand.
startTaskFailed	integer (int32)	Die Anzahl der Compute-Knoten im StartTaskFailed-Zustand.
starting	integer (int32)	Die Anzahl der Rechenknoten im Startzustand.
total	integer (int32)	Die Gesamtzahl der Rechenknoten.
unknown	integer (int32)	Die Anzahl der Compute Nodes im unbekannten Zustand.
unusable	integer (int32)	Die Anzahl der Rechenknoten im unbrauchbaren Zustand.
upgradingOS	integer (int32)	Die Anzahl der Compute-Nodes im UpgradingOS-Zustand.
waitingForStartTask	integer (int32)	Die Anzahl der Compute-Knoten im Zustand waitingForStartTask.

BatchPoolNodeCounts

Objekt

Die Anzahl der Computeknoten in jedem Zustand für einen Pool.

Name	Typ	Beschreibung
dedicated	BatchNodeCounts	Die Anzahl der dedizierten Compute-Knoten in jedem Zustand.
lowPriority	BatchNodeCounts	Die Anzahl der Spot-/Low-Priority-Compute-Nodes in jedem Zustand.
poolId	string	Die ID des Pools.

BatchPoolNodeCountsListResult

Objekt

Das Ergebnis der Auflistung der Computeknotenanzahl im Konto.

Name	Typ	Beschreibung
odata.nextLink	string (uri)	Die URL zum Abrufen der nächsten Ergebnisse.
value	BatchPoolNodeCounts[]	Eine Liste der Compute Node-Zählungen nach Pool.

Freigeben über

Pools - List Pool Node Counts

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

OAuth2Auth

Bereiche

Beispiele

NodeCountsPayload

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeCounts

BatchPoolNodeCounts

BatchPoolNodeCountsListResult