Account - List Pool Node Counts

Referenz

Dienst:: Batch Service

API-Version:: 2024-07-01.20.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=2024-07-01.20.0

Mit optionalen Parametern:

GET {batchUrl}/nodecounts?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.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://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer (int32) minimum: 1 maximum: 10	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 ausgeben kann. Der Standardwert ist 30 Sekunden. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

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 Clientanforderungs-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. Header client-request-id: string request-id: string
Other Status Codes	BatchError	Der Fehler vom Batchdienst.

Name

Typ

Beschreibung

200 OK

PoolNodeCountsListResult

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

Header

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

Other Status Codes

BatchError

Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

NodeCountsPayload

Beispielanforderung

HTTP

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

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

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	ErrorMessage	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.

ErrorMessage

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.

NodeCounts

Objekt

Die Anzahl der Computeknoten in jedem Computeknotenstatus.

Name	Typ	Beschreibung
creating	integer (int32)	Die Anzahl der Computeknoten im Erstellungszustand.
deallocated	integer (int32)	Die Anzahl der Computeknoten im Deallocated-Zustand.
deallocating	integer (int32)	Die Anzahl der Computeknoten im Deallocating-Zustand.
idle	integer (int32)	Die Anzahl der Computeknoten im Leerlaufzustand.
leavingPool	integer (int32)	Die Anzahl der Computeknoten im LeavingPool-Zustand.
offline	integer (int32)	Die Anzahl der Computeknoten im Offlinezustand.
preempted	integer (int32)	Die Anzahl der Computeknoten im präempzierten Zustand.
rebooting	integer (int32)	Die Anzahl der Computeknoten im Neustartstatus.
reimaging	integer (int32)	Die Anzahl der Computeknoten im Neuformatierungszustand.
running	integer (int32)	Die Anzahl der Computeknoten im ausgeführten Zustand.
startTaskFailed	integer (int32)	Die Anzahl der Computeknoten im StartTaskFailed-Zustand.
starting	integer (int32)	Die Anzahl der Computeknoten im Anfangszustand.
total	integer (int32)	Die Gesamtzahl der Computeknoten.
unknown	integer (int32)	Die Anzahl der Computeknoten im unbekannten Zustand.
unusable	integer (int32)	Die Anzahl der Computeknoten im nicht verwendbaren Zustand.
upgradingOS	integer (int32)	Die Anzahl der Computeknoten im UpgradeOS-Zustand.
waitingForStartTask	integer (int32)	Die Anzahl der Computeknoten im Zustand "waitingForStartTask".

PoolNodeCounts

Objekt

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 mit Spot-/Niedriger Priorität in jedem Zustand.
poolId	string	Die ID des Pools.

PoolNodeCountsListResult

Objekt

Das Ergebnis der Auflistung der Computeknotenanzahl im Konto.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL, um den nächsten Satz von Ergebnissen abzurufen.
value	PoolNodeCounts[]	Eine Liste der Computeknotenanzahl nach Pool.

Freigeben über

Account - List Pool Node Counts

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Bereiche

Authorization

Beispiele

NodeCountsPayload

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Zusätzliche Ressourcen