Pool - Enable Auto Scale

Služba:

Batch Service

Verze rozhraní API:

2024-07-01.20.0

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

S volitelnými parametry:

POST {batchUrl}/pools/{poolId}/enableautoscale?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 chcete povolit automatické š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.
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.
If-Modified-Since		string date-time-rfc1123	Č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-rfc1123	Č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.

Text požadavku

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

Name	Typ	Description
autoScaleEvaluationInterval	string	Č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, zastaví se stávající plán vyhodnocení automatického škálování a spustí se nový plán vyhodnocení automatického škálování, přičemž počáteční čas je čas vydání této žádosti.
autoScaleFormula	string	Vzorec pro požadovaný počet výpočetních uzlů ve fondu. Vzorec se zkontroluje na platnost, než se použije u fondu. Pokud vzorec není platný, služba Batch žádost odmítne s podrobnými informacemi o chybě. 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://azure.microsoft.com/documentation/articles/batch-automatic-scaling).

Odpovědi

Name	Typ	Description
200 OK		Požadavek na službu Batch byl úspěš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 enable autoscale

Ukázkový požadavek

HTTP

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



{
  "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
ErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
PoolEnableAutoScaleParameter	Možnosti povolení automatického škálování ve fondu

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.

PoolEnableAutoScaleParameter

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

Name	Typ	Description
autoScaleEvaluationInterval	string	Č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, zastaví se stávající plán vyhodnocení automatického škálování a spustí se nový plán vyhodnocení automatického škálování, přičemž počáteční čas je čas vydání této žádosti.
autoScaleFormula	string	Vzorec pro požadovaný počet výpočetních uzlů ve fondu. Vzorec se zkontroluje na platnost, než se použije u fondu. Pokud vzorec není platný, služba Batch žádost odmítne s podrobnými informacemi o chybě. 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://azure.microsoft.com/documentation/articles/batch-automatic-scaling).