Account - List Pool Node Counts

Referenz

Service:: Batch Service

API Version:: 2023-11-01.18.0

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 {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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
api-version	query	True	string	Client-API-Version.
$filter	query		string	Eine OData-$filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer int32	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name	Typ	Beschreibung
client-request-id	string uuid	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 client-request-ID in der Antwort zurückgeben soll.
ocp-date	string date-time-rfc1123	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	PoolNodeCountsListResult	Die Antwort enthält die Anzahl der Computeknoten in jedem Computeknotenstatus, gruppiert nach Pool. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Der Fehler vom Batch-Dienst.

Name

Typ

Beschreibung

200 OK

PoolNodeCountsListResult

Die Antwort enthält die Anzahl der Computeknoten in jedem Computeknotenstatus, gruppiert nach Pool.

Headers

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

Other Status Codes

BatchError

Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Authorization

Type: apiKey
In: header

Beispiele

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

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.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.
NodeCounts	Die Anzahl der Computeknoten in jedem Computeknotenstatus.
PoolNodeCounts	Die Anzahl der Computeknoten in jedem Zustand für einen Pool.
PoolNodeCountsListResult	Das Ergebnis der Auflistung der Computeknotenanzahl im Konto.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler.

BatchErrorDetail

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.

ErrorMessage

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

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

NodeCounts

Die Anzahl der Computeknoten in jedem Computeknotenstatus.

Name	Typ	Beschreibung
creating	integer	Die Anzahl der Computeknoten im Erstellungszustand.
idle	integer	Die Anzahl der Computeknoten im Leerlaufzustand.
leavingPool	integer	Die Anzahl der Computeknoten im LeavingPool-Zustand.
offline	integer	Die Anzahl der Computeknoten im Offlinezustand.
preempted	integer	Die Anzahl der Computeknoten im vorzeitig entfernten Zustand.
rebooting	integer	Die Anzahl der Computeknoten im Neustartstatus.
reimaging	integer	Die Anzahl der Computeknoten im Reimagingzustand.
running	integer	Die Anzahl der Computeknoten im Ausgeführten Zustand.
startTaskFailed	integer	Die Anzahl der Computeknoten im StartTaskFailed-Zustand.
starting	integer	Die Anzahl der Computeknoten im Startzustand.
total	integer	Die Gesamtanzahl der Computeknoten.
unknown	integer	Die Anzahl der Computeknoten im unbekannten Zustand.
unusable	integer	Die Anzahl der Computeknoten im nicht verwendbaren Zustand.
waitingForStartTask	integer	Die Anzahl der Computeknoten im Zustand waitingForStartTask.

PoolNodeCounts

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

Name	Typ	Beschreibung
dedicated	NodeCounts	Die Anzahl der dedizierten Computeknoten in jedem Zustand.
lowPriority	NodeCounts	Die Anzahl der Computeknoten spot/low-priority in jedem Zustand.
poolId	string	Die ID des Pools.

PoolNodeCountsListResult

Das Ergebnis der Auflistung der Computeknotenanzahl im Konto.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL zum Abrufen des nächsten Resultsets.
value	PoolNodeCounts[]	Eine Liste der Computeknotenzählungen nach Pool.

Share via

Account - List Pool Node Counts

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Scopes

Authorization

Beispiele

NodeCountsPayload

Sample Request

Sample Response

Definitionen

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Zusätzliche Ressourcen