Pools - Evaluate Pool Auto Scale

Služba:

Batch Service

Verze rozhraní API:

2025-06-01

Získá výsledek vyhodnocení vzorce automatického škálování ve fondu.
Toto rozhraní API je primárně určené pro ověřování vzorce automatického škálování, protože jednoduše vrátí výsledek bez použití vzorce ve fondu. Aby bylo možné vyhodnotit vzorec, musí mít fond povolené automatické škálování.

POST {endpoint}/pools/{poolId}/evaluateautoscale?api-version=2025-06-01

S volitelnými parametry:

POST {endpoint}/pools/{poolId}/evaluateautoscale?api-version=2025-06-01&timeOut={timeOut}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Koncový bod účtu Batch (například: https://batchaccount.eastus2.batch.azure.com).
poolId	path	True	string	ID poolu, na kterém se vyhodnocuje automatický škálovací vzorec.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
timeOut	query		integer (int32)	Maximální doba, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.".

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.
ocp-date		string (date-time-rfc7231)	Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.

Text požadavku

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

Name	Vyžadováno	Typ	Description
autoScaleFormula	True	string	Vzorec pro požadovaný počet výpočetních uzlů ve fondu. Vzorec je ověřen a jeho výsledky vypočítány, ale není aplikován na Pool. Pro aplikaci vzorce na Pool použijte 'Povolte automatické škálování na Poolu'. Pro více informací o specifikaci tohoto vzorce viz Automaticky škálovat výpočetní uzly v Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Odpovědi

Name	Typ	Description
200 OK	AutoScaleRun	Požadavek byl úspěšný. Hlavičky DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Neočekávaná chybová odpověď

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

Name	Description
https://batch.core.windows.net//.default

Příklady

Pool evaluate autoscale

Ukázkový požadavek

HTTP

POST {endpoint}/pools/poolId/evaluateautoscale?api-version=2025-06-01



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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
AutoScaleRun	Výsledky a chyby při provádění vzorce automatického škálování fondu.
AutoScaleRunError	Při provádění nebo vyhodnocování vzorce automatického škálování fondu došlo k chybě.
BatchError	Odpověď na chybu přijatá ze služby Azure Batch
BatchErrorDetail	Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch
BatchErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
BatchPoolEvaluateAutoScaleOptions	Parametry pro vyhodnocení vzorce automatického škálování ve fondu Azure Batch
NameValuePair	Představuje dvojici název-hodnota.

AutoScaleRun

Objekt

Výsledky a chyby při provádění vzorce automatického škálování fondu.

Name	Typ	Description
error	AutoScaleRunError	Podrobnosti o chybě, která se vyskytla při vyhodnocování vzorce automatického škálování v poolu, pokud bylo vyhodnocení neúspěšné.
results	string	Konečné hodnoty všech proměnných použitých při vyhodnocení vzorce automatického škálování Každá hodnota proměnné se vrátí ve formuláři $variable=value a proměnné jsou oddělené středníky.
timestamp	string (date-time)	Čas posledního vyhodnocení vzorce automatického škálování

AutoScaleRunError

Objekt

Při provádění nebo vyhodnocování vzorce automatického škálování fondu došlo k chybě.

Name	Typ	Description
code	string	Identifikátor pro chybu automatického měřítka. Kódy jsou invariantní a mají být využity programově.
message	string	Zpráva popisující chybu automatického škálování, určená k zobrazení v uživatelském rozhraní.
values	NameValuePair[]	Seznam dalších chybových detailů souvisejících s chybou autoscale.

BatchError

Objekt

Odpověď na chybu přijatá ze služby Azure Batch

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message	BatchErrorMessage	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Objekt

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

Name	Typ	Description
key	string	Identifikátor určující význam vlastnosti Value.
value	string	Další informace zahrnuté v odpovědi na chybu.

BatchErrorMessage

Objekt

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

Name	Typ	Description
lang	string	Jazykový kód chybové zprávy.
value	string	Text zprávy.

BatchPoolEvaluateAutoScaleOptions

Objekt

Parametry pro vyhodnocení vzorce automatického škálování ve fondu Azure Batch

Name	Typ	Description
autoScaleFormula	string	Vzorec pro požadovaný počet výpočetních uzlů ve fondu. Vzorec je ověřen a jeho výsledky vypočítány, ale není aplikován na Pool. Pro aplikaci vzorce na Pool použijte 'Povolte automatické škálování na Poolu'. Pro více informací o specifikaci tohoto vzorce viz Automaticky škálovat výpočetní uzly v Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

NameValuePair

Objekt

Představuje dvojici název-hodnota.

Name	Typ	Description
name	string	Jméno v páru jméno-hodnota.
value	string	Hodnota v páru jméno-hodnota.