Pool - Resize

  • Referenz
Service:
Batch Service
API Version:
2023-11-01.18.0

Ändert die Anzahl der Computeknoten, die einem Pool zugewiesen sind.
Sie können die Größe eines Pools nur ändern, wenn der Zuordnungsstatus konstant ist. Wenn die Größe des Pools bereits geändert wird, schlägt die Anforderung mit status Code 409 fehl. Wenn Sie die Größe eines Pools ändern, ändert sich der Zuordnungsstatus des Pools von "stabil" in "Größe". Sie können die Größe von Pools, die für die automatische Skalierung konfiguriert sind, nicht ändern. Wenn Sie dies versuchen, gibt der Batch-Dienst den Fehler 409 zurück. Wenn Sie die Größe eines Pools nach unten ändern, wählt der Batch-Dienst aus, welche Computeknoten entfernt werden sollen. Um bestimmte Computeknoten zu entfernen, verwenden Sie stattdessen die Api zum Entfernen von Computeknoten im Pool.

POST {batchUrl}/pools/{poolId}/resize?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/resize?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.
poolId
 path True

string

Die ID des Pools, der die Größe ändern soll.
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 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. explizit festlegen, 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 genau dem vom Client angegebenen Wert entspricht.
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 der angegebenen Zeit 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 der angegebenen Zeit nicht mehr geändert wurde.

Anforderungstext

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

Name Typ Beschreibung
nodeDeallocationOption

ComputeNodeDeallocationOption

Bestimmt, was mit einem Computeknoten und seinen ausgeführten Aufgaben zu tun ist, wenn die Poolgröße abnimmt.
Der Standardwert ist „requeue“.
resizeTimeout

string

Das Timeout für die Zuordnung von Knoten zum Pool oder das Entfernen von Computeknoten aus dem Pool.
Der Standardwert beträgt 15 Minuten. Der Mindestwert beträgt 5 Minuten. Wenn Sie einen Wert kleiner als 5 Minuten angeben, gibt der Batch-Dienst einen Fehler zurück. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-status Code 400 (Ungültige Anforderung).
targetDedicatedNodes

integer

Die gewünschte Anzahl dedizierter Computeknoten im Pool.
targetLowPriorityNodes

integer

Die gewünschte Anzahl von Computeknoten mit spot/low-priority im Pool.

Antworten

Name Typ Beschreibung
202 Accepted

Die Anforderung an den Batch-Dienst war erfolgreich.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: 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

Pool resize

Sample Request

POST account.region.batch.azure.com/pools/resizePool/resize?api-version=2023-11-01.18.0



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

Sample Response

Status code:
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 zu tun ist, nachdem er für die Deallocation ausgewählt wurde.
ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.
PoolResizeParameter

Optionen zum Ändern der Größe eines Pools.

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, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values

BatchErrorDetail[]

Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthält.

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 zu tun ist, nachdem er für die Deallocation ausgewählt wurde.

Name Typ Beschreibung
requeue

string

Beenden Sie ausgeführte Aufgabenprozesse, und stellen Sie die Aufgaben 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

Lassen Sie den Abschluss aktuell ausgeführter Tasks zu, und warten Sie dann, bis alle Aufbewahrungsfristen für Aufgabendaten ablaufen. Planen Sie während des Wartens keine neuen Aufgaben. Entfernen Sie Computeknoten, wenn alle Aufgabenaufbewahrungszeiträume abgelaufen sind.
taskcompletion

string

Zulassen, dass derzeit ausgeführte Tasks abgeschlossen werden. 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 Aufgaben werden mit failureInfo abgeschlossen, die angibt, dass sie beendet wurden, und werden nicht erneut ausgeführt. Entfernen Sie Computeknoten, sobald Aufgaben beendet wurden.

ErrorMessage

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

Name Typ Beschreibung
lang

string

Der Sprachcode der Fehlermeldung
value

string

Der Text der Meldung.

PoolResizeParameter

Optionen zum Ändern der Größe eines Pools.

Name Typ Beschreibung
nodeDeallocationOption

ComputeNodeDeallocationOption

Bestimmt, was mit einem Computeknoten und seinen ausgeführten Aufgaben zu tun ist, wenn die Poolgröße abnimmt.
Der Standardwert ist „requeue“.
resizeTimeout

string

Das Timeout für die Zuordnung von Knoten zum Pool oder das Entfernen von Computeknoten aus dem Pool.
Der Standardwert beträgt 15 Minuten. Der Mindestwert beträgt 5 Minuten. Wenn Sie einen Wert kleiner als 5 Minuten angeben, gibt der Batch-Dienst einen Fehler zurück. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-status Code 400 (Ungültige Anforderung).
targetDedicatedNodes

integer

Die gewünschte Anzahl dedizierter Computeknoten im Pool.
targetLowPriorityNodes

integer

Die gewünschte Anzahl von Computeknoten mit spot/low-priority im Pool.