Pool - Remove Nodes

Dienst:

Batch Service

API-Version:

2024-07-01.20.0

Entfernt Computeknoten aus dem angegebenen Pool.
Dieser Vorgang kann nur ausgeführt werden, wenn der Zuordnungsstatus des Pools stabil ist. Wenn dieser Vorgang ausgeführt wird, ändert sich der Zuordnungsstatus von stetig in Größenänderung. Jede Anforderung kann bis zu 100 Knoten entfernen.

POST {batchUrl}/pools/{poolId}/removenodes?api-version=2024-07-01.20.0

Mit optionalen Parametern:

POST {batchUrl}/pools/{poolId}/removenodes?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.
poolId	path	True	string	Die ID des Pools, aus dem Sie Computeknoten entfernen möchten.
api-version	query	True	string	Client-API-Version.
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	Erforderlich	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.
If-Match		string	Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst exakt mit dem vom Client angegebenen Wert übereinstimmt.
If-None-Match		string	Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst nicht mit dem vom Client angegebenen Wert übereinstimmt.
If-Modified-Since		string (date-time-rfc1123)	Ein Zeitstempel, der die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt geändert wurde.
If-Unmodified-Since		string (date-time-rfc1123)	Ein Zeitstempel, der die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt nicht geändert wurde.

Anforderungstext

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

Name	Erforderlich	Typ	Beschreibung
nodeList	True	string[]	Eine Liste, die die IDs der Computeknoten enthält, die aus dem angegebenen Pool entfernt werden sollen. Pro Anforderung können maximal 100 Knoten entfernt werden.
nodeDeallocationOption		ComputeNodeDeallocationOption	Bestimmt, was mit einem Computeknoten und seinen ausgeführten Aufgaben ausgeführt werden soll, nachdem er für die Deallocation ausgewählt wurde. Der Standardwert wird erneut abfragt.
resizeTimeout		string (duration)	Das Timeout zum Entfernen von Computeknoten in den Pool. Der Standardwert beträgt 15 Minuten. Der Mindestwert beträgt 5 Minuten. Wenn Sie einen Wert kleiner als 5 Minuten angeben, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung an den Batchdienst war erfolgreich. Header client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: 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

Pool remove nodes

Beispielanforderung

HTTP

POST account.region.batch.azure.com/pools/poolId/removenodes?api-version=2024-07-01.20.0



{
  "nodeList": [
    "tvm-1695681911_1-20161122t224741z",
    "tvm-1695681911_2-20161122t224741z"
  ]
}

Beispiel für eine Antwort

Statuscode:

202

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.
ComputeNodeDeallocationOption	Bestimmt, was mit einem Computeknoten und seinen ausgeführten Aufgaben ausgeführt werden soll, nachdem er für die Deallocation ausgewählt wurde.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
NodeRemoveParameter	Optionen zum Entfernen von Computeknoten aus einem Pool.

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.

ComputeNodeDeallocationOption

Enumeration

Bestimmt, was mit einem Computeknoten und seinen ausgeführten Aufgaben ausgeführt werden soll, nachdem er für die Deallocation ausgewählt wurde.

Wert	Beschreibung
requeue	Beenden Sie die Ausführung von Aufgabenprozessen, und stellen Sie die Aufgaben erneut ab. Die Aufgaben werden erneut ausgeführt, wenn ein Computeknoten verfügbar ist. Entfernen Sie Computeknoten, sobald Aufgaben beendet wurden.
retaineddata	Zulassen, dass derzeit ausgeführte Aufgaben abgeschlossen werden, und warten Sie dann, bis alle Aufbewahrungszeiträume für Aufgabendaten ablaufen. Planen Sie beim Warten keine neuen Vorgänge. Entfernen Sie Computeknoten, wenn alle Aufbewahrungszeiträume des Vorgangs abgelaufen sind.
taskcompletion	Zurzeit ausführende Aufgaben zulassen. Planen Sie beim Warten keine neuen Vorgänge. Entfernen Sie Computeknoten, wenn alle Aufgaben abgeschlossen wurden.
terminate	Beenden Sie die Ausführung von Aufgaben. Die Aufgaben werden mit failureInfo abgeschlossen, die angibt, dass sie beendet wurden und nicht erneut ausgeführt werden. Entfernen Sie Computeknoten, sobald Aufgaben beendet wurden.

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

NodeRemoveParameter

Objekt

Optionen zum Entfernen von Computeknoten aus einem Pool.

Name	Typ	Beschreibung
nodeDeallocationOption	ComputeNodeDeallocationOption	Bestimmt, was mit einem Computeknoten und seinen ausgeführten Aufgaben ausgeführt werden soll, nachdem er für die Deallocation ausgewählt wurde. Der Standardwert wird erneut abfragt.
nodeList	string[]	Eine Liste, die die IDs der Computeknoten enthält, die aus dem angegebenen Pool entfernt werden sollen. Pro Anforderung können maximal 100 Knoten entfernt werden.
resizeTimeout	string (duration)	Das Timeout zum Entfernen von Computeknoten in den Pool. Der Standardwert beträgt 15 Minuten. Der Mindestwert beträgt 5 Minuten. Wenn Sie einen Wert kleiner als 5 Minuten angeben, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).