Pool - Evaluate Auto Scale

Služba:

Batch Service

Verze rozhraní API:

2024-07-01.20.0

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 {batchUrl}/pools/{poolId}/evaluateautoscale?api-version=2024-07-01.20.0

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky služby Azure Batch.
poolId	path	True	string	ID fondu, na kterém se má vyhodnotit vzorec automatického škálování.
api-version	query	True	string	Verze rozhraní API klienta.
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 uuid	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-rfc1123	Č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 se ověří a jeho výsledky se vypočítají, ale pro fond se nepoužijí. Pokud chcete vzorec použít u fondu, povolte automatické škálování ve fondu. Další informace o zadání tohoto vzorce najdete v tématu Automatické škálování výpočetních uzlů ve fondu služby Azure Batch (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Odpovědi

Name	Typ	Description
200 OK	AutoScaleRun	Odpověď obsahující výsledky vyhodnocení automatického škálování Hlavičky client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Tok ověřovacího kódu Microsoft Entra OAuth 2.0

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

Rozsahy

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Typ: apiKey
V: header

Příklady

Pool evaluate autoscale

Ukázkový požadavek

HTTP

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



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

Ukázková odpověď

Stavový kód:

200

{
  "timestamp": "2016-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
ErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
NameValuePair	Představuje dvojici název-hodnota.
PoolEvaluateAutoScaleParameter	Možnosti vyhodnocení vzorce automatického škálování ve fondu

AutoScaleRun

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

Name	Typ	Description
error	AutoScaleRunError	Podrobnosti o chybě, ke které došlo při vyhodnocování vzorce automatického škálování ve fondu, pokud vyhodnocení nebylo ú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	Čas posledního vyhodnocení vzorce automatického škálování

AutoScaleRunError

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 chyby automatického škálování Kódy jsou invariantní a mají být využity programově.
message	string	Zpráva popisující chybu automatického škálování, která má být vhodná pro zobrazení v uživatelském rozhraní.
values	NameValuePair[]	Seznam dalších podrobností o chybách souvisejících s chybou automatického škálování

BatchError

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	ErrorMessage	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

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.

ErrorMessage

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

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy.

NameValuePair

Představuje dvojici název-hodnota.

Name	Typ	Description
name	string	Název v páru name-value.
value	string	Hodnota v páru name-value.

PoolEvaluateAutoScaleParameter

Možnosti vyhodnocení vzorce automatického škálování ve fondu

Name	Typ	Description
autoScaleFormula	string	Vzorec pro požadovaný počet výpočetních uzlů ve fondu. Vzorec se ověří a jeho výsledky se vypočítají, ale pro fond se nepoužijí. Pokud chcete vzorec použít u fondu, povolte automatické škálování ve fondu. Další informace o zadání tohoto vzorce najdete v tématu Automatické škálování výpočetních uzlů ve fondu služby Azure Batch (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).