Pool - Enable Auto Scale

  • Referenz
Dienst:
Batch Service
API-Version:
2024-07-01.20.0

Aktiviert die automatische Skalierung für einen Pool.
Sie können die automatische Skalierung für einen Pool nicht aktivieren, wenn ein Vorgang zum Ändern der Größe im Pool ausgeführt wird. Wenn die automatische Skalierung des Pools derzeit deaktiviert ist, müssen Sie eine gültige Autoskalenformel als Teil der Anforderung angeben. Wenn die automatische Skalierung des Pools bereits aktiviert ist, können Sie eine neue Autoskalenformel und/oder ein neues Auswertungsintervall angeben. Sie können diese API nicht für denselben Pool mehr als einmal alle 30 Sekunden aufrufen.

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2024-07-01.20.0
Mit optionalen Parametern: 
POST {batchUrl}/pools/{poolId}/enableautoscale?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, auf dem die automatische Skalierung aktiviert werden 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 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 Typ Beschreibung
autoScaleEvaluationInterval

string

Das Zeitintervall, in dem die Poolgröße automatisch entsprechend der Autoskalenformel angepasst werden soll.
Der Standardwert beträgt 15 Minuten. Der Mindest- und Maximalwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batchdienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Wenn Sie ein neues Intervall angeben, wird der vorhandene Zeitplan für die Auswertung der Automatischen Skalierung beendet, und ein neuer Zeitplan für die Automatische Skalierungsauswertung wird gestartet, wobei der Startzeit der Zeitpunkt, zu dem diese Anforderung ausgestellt wurde, beginnt.
autoScaleFormula

string

Die Formel für die gewünschte Anzahl von Computeknoten im Pool.
Die Formel wird auf Gültigkeit überprüft, bevor sie auf den Pool angewendet wird. Wenn die Formel ungültig ist, lehnt der Batchdienst die Anforderung mit detaillierten Fehlerinformationen ab. Weitere Informationen zum Angeben dieser Formel finden Sie unter Automatisches Skalieren von Computeknoten in einem Azure-Batchpool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling).

Antworten

Name Typ Beschreibung
200 OK

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 enable autoscale

Beispielanforderung

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



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Beispiel für eine Antwort

Statuscode:
200

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

Optionen zum Aktivieren der automatischen Skalierung in 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 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

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

PoolEnableAutoScaleParameter

Optionen zum Aktivieren der automatischen Skalierung in einem Pool.

Name Typ Beschreibung
autoScaleEvaluationInterval

string

Das Zeitintervall, in dem die Poolgröße automatisch entsprechend der Autoskalenformel angepasst werden soll.
Der Standardwert beträgt 15 Minuten. Der Mindest- und Maximalwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batchdienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Wenn Sie ein neues Intervall angeben, wird der vorhandene Zeitplan für die Auswertung der Automatischen Skalierung beendet, und ein neuer Zeitplan für die Automatische Skalierungsauswertung wird gestartet, wobei der Startzeit der Zeitpunkt, zu dem diese Anforderung ausgestellt wurde, beginnt.
autoScaleFormula

string

Die Formel für die gewünschte Anzahl von Computeknoten im Pool.
Die Formel wird auf Gültigkeit überprüft, bevor sie auf den Pool angewendet wird. Wenn die Formel ungültig ist, lehnt der Batchdienst die Anforderung mit detaillierten Fehlerinformationen ab. Weitere Informationen zum Angeben dieser Formel finden Sie unter Automatisches Skalieren von Computeknoten in einem Azure-Batchpool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling).