Pool - Evaluate Auto Scale

Dienst:

Batch Service

API-Version:

2024-07-01.20.0

Ruft das Ergebnis der Auswertung einer automatischen Skalierungsformel im Pool ab.
Diese API dient in erster Linie zum Validieren einer Autoskalenformel, da sie einfach das Ergebnis zurückgibt, ohne die Formel auf den Pool anzuwenden. Der Pool muss die automatische Skalierung aktiviert haben, um eine Formel auszuwerten.

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

Mit optionalen Parametern:

POST {batchUrl}/pools/{poolId}/evaluateautoscale?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, für den die automatische Skalierungsformel ausgewertet 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.

Anforderungstext

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

Name	Erforderlich	Typ	Beschreibung
autoScaleFormula	True	string	Die Formel für die gewünschte Anzahl von Computeknoten im Pool. Die Formel wird überprüft, und die Ergebnisse werden berechnet, aber nicht auf den Pool angewendet. Um die Formel auf den Pool anzuwenden, "Automatische Skalierung für einen Pool aktivieren". Weitere Informationen zum Angeben dieser Formel finden Sie unter "Automatisches Skalieren von Computeknoten in einem Azure-Batchpool" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Antworten

Name	Typ	Beschreibung
200 OK	AutoScaleRun	Eine Antwort, die die Ergebnisse der Autoskalenauswertung enthält. 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 evaluate autoscale

Beispielanforderung

HTTP

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



{
  "autoScaleFormula": "$TargetDedicated=1"
}

Beispiel für eine Antwort

Statuscode:

200

{
  "timestamp": "2016-11-22T19:39:28.5246331Z",
  "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}

Definitionen

Name	Beschreibung
AutoScaleRun	Die Ergebnisse und Fehler aus einer Ausführung einer Autoskalenformel des Pools.
AutoScaleRunError	Fehler beim Ausführen oder Auswerten einer Autoskalierungsformel des Pools.
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.
NameValuePair	Stellt ein Name-Wert-Paar dar.
PoolEvaluateAutoScaleParameter	Optionen zum Auswerten einer automatischen Skalierungsformel in einem Pool.

AutoScaleRun

Die Ergebnisse und Fehler aus einer Ausführung einer Autoskalenformel des Pools.

Name	Typ	Beschreibung
error	AutoScaleRunError	Details zum Fehler beim Auswerten der Autoskalenformel im Pool, wenn die Auswertung nicht erfolgreich war.
results	string	Die Endwerte aller Variablen, die bei der Auswertung der Autoskalenformel verwendet werden. Jeder Variablenwert wird im Formular $variable=Wert zurückgegeben, und Variablen werden durch Semikolons getrennt.
timestamp	string	Die Zeit, zu der die Autoskalenformel zuletzt ausgewertet wurde.

AutoScaleRunError

Fehler beim Ausführen oder Auswerten einer Autoskalierungsformel des Pools.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Autoskalenfehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message	string	Eine Meldung, die den Autoskalenfehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values	NameValuePair[]	Eine Liste zusätzlicher Fehlerdetails im Zusammenhang mit dem AutoScale-Fehler.

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.

NameValuePair

Stellt ein Name-Wert-Paar dar.

Name	Typ	Beschreibung
name	string	Der Name im Name-Wert-Paar.
value	string	Der Wert im Name-Wert-Paar.

PoolEvaluateAutoScaleParameter

Optionen zum Auswerten einer automatischen Skalierungsformel in einem Pool.

Name	Typ	Beschreibung
autoScaleFormula	string	Die Formel für die gewünschte Anzahl von Computeknoten im Pool. Die Formel wird überprüft, und die Ergebnisse werden berechnet, aber nicht auf den Pool angewendet. Um die Formel auf den Pool anzuwenden, "Automatische Skalierung für einen Pool aktivieren". Weitere Informationen zum Angeben dieser Formel finden Sie unter "Automatisches Skalieren von Computeknoten in einem Azure-Batchpool" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).