Pool - Evaluate Auto Scale
Hämtar resultatet av utvärderingen av en automatisk skalningsformel i poolen.
Det här API:et är främst till för att verifiera en autoskalningsformel, eftersom det helt enkelt returnerar resultatet utan att tillämpa formeln på poolen. Poolen måste ha automatisk skalning aktiverad för att kunna utvärdera en formel.
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-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Bas-URL:en för alla Azure Batch tjänstbegäranden. |
pool
|
path | True |
string |
ID:t för poolen som du vill utvärdera formeln för automatisk skalning på. |
api-version
|
query | True |
string |
Klient-API-version. |
timeout
|
query |
integer int32 |
Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. |
Begärandehuvud
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | Typ | Description |
---|---|---|---|
client-request-id |
string uuid |
Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Om servern ska returnera klient-request-id i svaret. |
|
ocp-date |
string date-time-rfc1123 |
Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det uttryckligen om du anropar REST-API:et direkt. |
Begärandetext
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | Typ | Description |
---|---|---|---|
autoScaleFormula | True |
string |
Formeln för önskat antal beräkningsnoder i poolen. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Ett svar som innehåller resultatet av autoskalningsutvärderingen. Sidhuvuden
|
|
Other Status Codes |
Felet från Batch-tjänsten. |
Säkerhet
azure_auth
Microsoft Entra autentiseringskodflöde för OAuth 2.0
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | Personifiera ditt användarkonto |
Authorization
Typ:
apiKey
I:
header
Exempel
Pool evaluate autoscale
Exempelbegäran
POST account.region.batch.azure.com/pools/poolId/evaluateautoscale?api-version=2023-11-01.18.0
{
"autoScaleFormula": "$TargetDedicated=1"
}
Exempelsvar
{
"timestamp": "2016-11-22T19:39:28.5246331Z",
"results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}
Definitioner
Name | Description |
---|---|
Auto |
Resultatet och felen från en körning av en autoskalningsformel för pooler. |
Auto |
Ett fel som uppstod vid körning eller utvärdering av en autoskalningsformel för pooler. |
Batch |
Ett felsvar som tagits emot från Azure Batch-tjänsten. |
Batch |
Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar. |
Error |
Ett felmeddelande som togs emot i ett Azure Batch felsvar. |
Name |
Representerar ett namn/värde-par. |
Pool |
Alternativ för att utvärdera en automatisk skalningsformel i en pool. |
AutoScaleRun
Resultatet och felen från en körning av en autoskalningsformel för pooler.
Name | Typ | Description |
---|---|---|
error |
Information om felet som påträffades vid utvärdering av autoskalningsformeln i poolen, om utvärderingen misslyckades. |
|
results |
string |
De slutliga värdena för alla variabler som används i utvärderingen av autoskalningsformeln. |
timestamp |
string |
Tiden då autoskalningsformeln senast utvärderades. |
AutoScaleRunError
Ett fel som uppstod vid körning eller utvärdering av en autoskalningsformel för pooler.
Name | Typ | Description |
---|---|---|
code |
string |
En identifierare för autoskalningsfelet. Koder är invarianta och är avsedda att användas programmatiskt. |
message |
string |
Ett meddelande som beskriver autoskalningsfelet, avsett att vara lämpligt för visning i ett användargränssnitt. |
values |
En lista med ytterligare felinformation som rör autoskalningsfelet. |
BatchError
Ett felsvar som tagits emot från Azure Batch-tjänsten.
Name | Typ | Description |
---|---|---|
code |
string |
En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt. |
message |
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt. |
|
values |
En samling nyckel/värde-par som innehåller ytterligare information om felet. |
BatchErrorDetail
Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
Name | Typ | Description |
---|---|---|
key |
string |
En identifierare som anger innebörden av egenskapen Value. |
value |
string |
Den ytterligare information som ingår i felsvaret. |
ErrorMessage
Ett felmeddelande som togs emot i ett Azure Batch felsvar.
Name | Typ | Description |
---|---|---|
lang |
string |
Språkkoden för felmeddelandet |
value |
string |
Texten i meddelandet. |
NameValuePair
Representerar ett namn/värde-par.
Name | Typ | Description |
---|---|---|
name |
string |
Namnet i namn/värde-paret. |
value |
string |
Värdet i namn/värde-paret. |
PoolEvaluateAutoScaleParameter
Alternativ för att utvärdera en automatisk skalningsformel i en pool.
Name | Typ | Description |
---|---|---|
autoScaleFormula |
string |
Formeln för önskat antal beräkningsnoder i poolen. |