Pool - Evaluate Auto Scale

Service:

Batch Service

API Version:

2023-11-01.18.0

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

POST {batchUrl}/pools/{poolId}/evaluateautoscale?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/evaluateautoscale?timeout={timeout}&api-version=2023-11-01.18.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 Azure Batch služby.
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, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

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, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.

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 Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Odpovědi

Name	Typ	Description
200 OK	AutoScaleRun	Odpověď obsahující výsledky vyhodnocení automatického škálování. Headers 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

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Authorization

Type: apiKey
In: header

Příklady

Pool evaluate autoscale

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/evaluateautoscale?api-version=2023-11-01.18.0



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

Sample Response

Status code:

200

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

Definice

Name	Description
AutoScaleRun	Výsledky a chyby při spuštění vzorce automatického škálování fondu
AutoScaleRunError	Chyba, ke které došlo při spouštění nebo vyhodnocování vzorce automatického škálování fondu.
BatchError	Služba Azure Batch obdržela chybovou odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
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 spuště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 formátu $variable=value a proměnné jsou oddělené středníky.
timestamp	string	Čas posledního vyhodnocení vzorce automatického škálování

AutoScaleRunError

Chyba, ke které došlo při spouštění nebo vyhodnocování vzorce automatického škálování fondu.

Name	Typ	Description
code	string	Identifikátor chyby automatického škálování. Kódy jsou neutrální a mají být využívány 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

Služba Azure Batch obdržela chybovou odpověď.

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

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

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

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

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 ve dvojici název-hodnota.
value	string	Hodnota ve dvojici název-hodnota.

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 Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).