Pool - Evaluate Auto Scale
Ruft das Ergebnis der Auswertung einer Formel für die automatische Skalierung im Pool ab.
Diese API dient in erster Linie zur Validierung einer Formel für die autoskalierte Skalierung, da sie einfach das Ergebnis zurückgibt, ohne die Formel auf den Pool anzuwenden. Für den Pool muss die automatische Skalierung aktiviert sein, um eine Formel auszuwerten.
POST {batchUrl}/pools/{poolId}/evaluateautoscale?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/evaluateautoscale?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, für den die Formel für die automatische Skalierung 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 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. |
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. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Eine Antwort, die die Ergebnisse der Auswertung der automatischen Skalierung enthält. 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 evaluate autoscale
Beispielanforderung
POST account.region.batch.azure.com/pools/poolId/evaluateautoscale?api-version=2023-11-01.18.0
{
"autoScaleFormula": "$TargetDedicated=1"
}
Beispiel für eine Antwort
{
"timestamp": "2016-11-22T19:39:28.5246331Z",
"results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}
Definitionen
Name | Beschreibung |
---|---|
Auto |
Die Ergebnisse und Fehler bei der Ausführung einer Formel für die automatische Skalierung des Pools. |
Auto |
Ein Fehler, der beim Ausführen oder Auswerten einer Formel für die automatische Skalierung von Pools aufgetreten ist. |
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind. |
Error |
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde. |
Name |
Stellt ein Name-Wert-Paar dar. |
Pool |
Optionen zum Auswerten einer Formel für die automatische Skalierung in einem Pool. |
AutoScaleRun
Die Ergebnisse und Fehler bei der Ausführung einer Formel für die automatische Skalierung des Pools.
Name | Typ | Beschreibung |
---|---|---|
error |
Details zum Fehler beim Auswerten der Formel für die automatische Skalierung im Pool, wenn die Auswertung nicht erfolgreich war. |
|
results |
string |
Die Endwerte aller Variablen, die bei der Auswertung der Formel für die autoskalierte Skalierung verwendet werden. |
timestamp |
string |
Der Zeitpunkt, zu dem die Formel für die automatische Skalierung zuletzt ausgewertet wurde. |
AutoScaleRunError
Ein Fehler, der beim Ausführen oder Auswerten einer Formel für die automatische Skalierung von Pools aufgetreten ist.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Fehler bei der automatischen Skalierung. Codes sind unveränderlich und sollten programmgesteuert verwendet werden. |
message |
string |
Eine Meldung, die den Fehler bei der automatischen Skalierung beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
values |
Eine Liste mit zusätzlichen Fehlerdetails im Zusammenhang mit dem Fehler bei der automatischen Skalierung. |
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. |
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. |
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 Formel für die automatische Skalierung in einem Pool.
Name | Typ | Beschreibung |
---|---|---|
autoScaleFormula |
string |
Die Formel für die gewünschte Anzahl von Computeknoten im Pool. |