Pools - Enable Pool Auto Scale

Služba:

Batch Service

Verze rozhraní API:

2025-06-01

Umožňuje automatické škálování fondu.
Automatické škálování ve fondu nelze povolit, pokud ve fondu probíhá operace změny velikosti. Pokud je automatické škálování fondu aktuálně zakázané, musíte jako součást požadavku zadat platný vzorec automatického škálování. Pokud už je povolené automatické škálování fondu, můžete zadat nový vzorec automatického škálování nebo nový interval vyhodnocení. Toto rozhraní API nelze volat pro stejný fond více než jednou každých 30 sekund.

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

S volitelnými parametry:

POST {endpoint}/pools/{poolId}/enableautoscale?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 fondu, které chcete získat.
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.
If-Modified-Since		string (date-time-rfc7231)	Časové razítko označující čas poslední změny prostředku známého klientovi. Operace bude provedena pouze v případě, že byl prostředek ve službě změněn od zadaného času.
If-Unmodified-Since		string (date-time-rfc7231)	Časové razítko označující čas poslední změny prostředku známého klientovi. Operace se provede pouze v případě, že se prostředek ve službě od zadaného času nezměnil.
If-Match		string	Hodnota ETag přidružená k verzi prostředku známého klientovi. Operace se provede pouze v případě, že aktuální značky ETag prostředku ve službě přesně odpovídají hodnotě určené klientem.
If-None-Match		string	Hodnota ETag přidružená k verzi prostředku známého klientovi. Operace se provede pouze v případě, že aktuální značky ETag prostředku ve službě neodpovídají hodnotě zadané klientem.

Text požadavku

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

Name	Typ	Description
autoScaleEvaluationInterval	string (duration)	Časový interval, ve kterém se má velikost fondu automaticky upravit podle vzorce automatického škálování. Výchozí hodnota je 15 minut. Minimální a maximální hodnota je 5 minut a 168 hodin. Pokud zadáte hodnotu kratší než 5 minut nebo delší než 168 hodin, služba Batch odmítne požadavek s chybou neplatné hodnoty vlastnosti; Pokud voláte přímo rozhraní REST API, stavový kód HTTP je 400 (chybný požadavek). Pokud zadáte nový interval, stávající harmonogram automatického hodnocení bude zastaven a spustí se nový harmonogram automatického škálování, jehož počáteční čas bude v okamžiku, kdy byl požadavek vydán.
autoScaleFormula	string	Vzorec pro požadovaný počet výpočetních uzlů ve fondu. Výchozí hodnota je 15 minut. Minimální a maximální hodnota je 5 minut a 168 hodin. Pokud zadáte hodnotu kratší než 5 minut nebo delší než 168 hodin, služba Batch odmítne požadavek s chybou neplatné hodnoty vlastnosti; Pokud voláte přímo rozhraní REST API, stavový kód HTTP je 400 (chybný požadavek). Pokud zadáte nový interval, stávající harmonogram automatického hodnocení bude zastaven a spustí se nový harmonogram automatického škálování, jehož počáteční čas bude v okamžiku, kdy byl požadavek vydán.

Odpovědi

Name	Typ	Description
200 OK		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 enable autoscale

Ukázkový požadavek

HTTP

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



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Ukázková odpověď

Stavový kód:

200

Definice

Name	Description
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.
BatchPoolEnableAutoScaleOptions	Parametry pro povolení automatického škálování ve fondu Azure Batch

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.

BatchPoolEnableAutoScaleOptions

Objekt

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

Name	Typ	Description
autoScaleEvaluationInterval	string (duration)	Časový interval, ve kterém se má velikost fondu automaticky upravit podle vzorce automatického škálování. Výchozí hodnota je 15 minut. Minimální a maximální hodnota je 5 minut a 168 hodin. Pokud zadáte hodnotu kratší než 5 minut nebo delší než 168 hodin, služba Batch odmítne požadavek s chybou neplatné hodnoty vlastnosti; Pokud voláte přímo rozhraní REST API, stavový kód HTTP je 400 (chybný požadavek). Pokud zadáte nový interval, stávající harmonogram automatického hodnocení bude zastaven a spustí se nový harmonogram automatického škálování, jehož počáteční čas bude v okamžiku, kdy byl požadavek vydán.
autoScaleFormula	string	Vzorec pro požadovaný počet výpočetních uzlů ve fondu. Výchozí hodnota je 15 minut. Minimální a maximální hodnota je 5 minut a 168 hodin. Pokud zadáte hodnotu kratší než 5 minut nebo delší než 168 hodin, služba Batch odmítne požadavek s chybou neplatné hodnoty vlastnosti; Pokud voláte přímo rozhraní REST API, stavový kód HTTP je 400 (chybný požadavek). Pokud zadáte nový interval, stávající harmonogram automatického hodnocení bude zastaven a spustí se nový harmonogram automatického škálování, jehož počáteční čas bude v okamžiku, kdy byl požadavek vydán.