Pool - Evaluate Auto Scale

Referens

Tjänst:: Batch Service

API-version:: 2024-07-01.20.0

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=2024-07-01.20.0

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch-tjänstbegäranden.
poolId	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. Om värdet är större än 30 används standardvärdet i stället.

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 explicit 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. Formeln verifieras och dess resultat beräknas, men den tillämpas inte på poolen. Om du vill tillämpa formeln på poolen aktiverar du automatisk skalning på en pool. Mer information om hur du anger den här formeln finns i "Skala beräkningsnoder automatiskt i en Azure Batch-pool" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Svar

Name

Typ

Description

200 OK

Ett svar som innehåller resultatet av autoskalningsutvärderingen.

Sidhuvuden

client-request-id: string
request-id: string
ETag: string
Last-Modified: string
DataServiceId: string

Other Status Codes

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra 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

HTTP

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



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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
AutoScaleRun	Resultatet och felen från en körning av en autoskalningsformel för pooler.
AutoScaleRunError	Ett fel som uppstod vid körning eller utvärdering av en autoskalningsformel för pooler.
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch-felsvar.
NameValuePair	Representerar ett namn/värde-par.
PoolEvaluateAutoScaleParameter	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	AutoScaleRunError	Information om felet påträffade 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. Varje variabelvärde returneras i formuläret $variable=value, och variabler avgränsas med semikolon.
timestamp	string	Den tid 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	NameValuePair[]	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	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	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. Formeln verifieras och dess resultat beräknas, men den tillämpas inte på poolen. Om du vill tillämpa formeln på poolen aktiverar du automatisk skalning på en pool. Mer information om hur du anger den här formeln finns i "Skala beräkningsnoder automatiskt i en Azure Batch-pool" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).