Pool - Remove Nodes
Entfernt Computeknoten aus dem angegebenen Pool.
Dieser Vorgang kann nur ausgeführt werden, wenn der Zuordnungsstatus des Pools konstant ist. Wenn dieser Vorgang ausgeführt wird, ändert sich der Zuordnungszustand von stabil in Größenänderung. Jede Anforderung kann bis zu 100 Knoten entfernen.
POST {batchUrl}/pools/{poolId}/removenodes?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/removenodes?timeout={timeout}&api-version=2023-11-01.18.0
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
batch
|
path | True |
string |
Die Basis-URL für alle Azure Batch-Dienstanforderungen. |
pool
|
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 aufwenden kann. Der Standardwert ist 30 Sekunden. |
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 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. |
|
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 im Dienst genau 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 den Zeitpunkt der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource im Dienst seit dem angegebenen Zeitpunkt geändert wurde. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Ein Zeitstempel, der den Zeitpunkt der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource im Dienst seit dem angegebenen Zeitpunkt nicht mehr geändert wurde. |
Anforderungstext
Media Types: "application/json; odata=minimalmetadata"
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
nodeList | True |
string[] |
Eine Liste mit den IDs der Computeknoten, die aus dem angegebenen Pool entfernt werden sollen. |
nodeDeallocationOption |
Bestimmt, was mit einem Computeknoten und seinen ausgeführten Aufgaben geschehen soll, nachdem er für die Zuordnung aufgehoben wurde. |
||
resizeTimeout |
string |
Das Timeout für das Entfernen von Computeknoten in den Pool. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
202 Accepted |
Die Anforderung an den Batch-Dienst war erfolgreich. Header
|
|
Other Status Codes |
Der Fehler vom Batch-Dienst. |
Sicherheit
azure_auth
Microsoft Entra OAuth 2.0-Authentifizierungscodeflow
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
POST account.region.batch.azure.com/pools/poolId/removenodes?api-version=2023-11-01.18.0
{
"nodeList": [
"tvm-1695681911_1-20161122t224741z",
"tvm-1695681911_2-20161122t224741z"
]
}
Beispiel für eine Antwort
Definitionen
Name | Beschreibung |
---|---|
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind. |
Compute |
Bestimmt, was mit einem Computeknoten und seinen ausgeführten Aufgaben geschehen soll, nachdem er für die Zuordnung aufgehoben wurde. |
Error |
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde. |
Node |
Optionen zum Entfernen von Computeknoten aus einem Pool. |
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 |
Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
values |
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. |
ComputeNodeDeallocationOption
Bestimmt, was mit einem Computeknoten und seinen ausgeführten Aufgaben geschehen soll, nachdem er für die Zuordnung aufgehoben wurde.
Name | Typ | Beschreibung |
---|---|---|
requeue |
string |
Beenden Sie ausgeführte Aufgabenprozesse, und stellen Sie die Tasks erneut in die Warteschlange. Die Tasks werden erneut ausgeführt, wenn ein Computeknoten verfügbar ist. Entfernen Sie Computeknoten, sobald Aufgaben beendet wurden. |
retaineddata |
string |
Zulassen, dass aktuell ausgeführte Tasks abgeschlossen werden, und warten Sie dann, bis alle Aufbewahrungszeiträume für Aufgabendaten ablaufen. Planen Sie während des Wartens keine neuen Aufgaben. Entfernen Sie Computeknoten, wenn alle Aufbewahrungszeiträume für Aufgaben abgelaufen sind. |
taskcompletion |
string |
Das Abschließen aktuell ausgeführter Tasks zulassen. Planen Sie während des Wartens keine neuen Aufgaben. Entfernen Sie Computeknoten, wenn alle Aufgaben abgeschlossen sind. |
terminate |
string |
Beenden Sie ausgeführte Tasks. Die Tasks werden mit failureInfo abgeschlossen, was angibt, dass sie beendet wurden, und wird nicht erneut ausgeführt. Entfernen Sie Computeknoten, sobald Aufgaben beendet wurden. |
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. |
NodeRemoveParameter
Optionen zum Entfernen von Computeknoten aus einem Pool.
Name | Typ | Beschreibung |
---|---|---|
nodeDeallocationOption |
Bestimmt, was mit einem Computeknoten und seinen ausgeführten Aufgaben geschehen soll, nachdem er für die Zuordnung aufgehoben wurde. |
|
nodeList |
string[] |
Eine Liste mit den IDs der Computeknoten, die aus dem angegebenen Pool entfernt werden sollen. |
resizeTimeout |
string |
Das Timeout für das Entfernen von Computeknoten in den Pool. |