Pool - Resize

Reference

Service:: Batch Service

API Version:: 2023-11-01.18.0

Změní počet výpočetních uzlů přiřazených k fondu.
Velikost fondu můžete změnit pouze v případech, kdy je jeho stav přidělení stabilní. Pokud se velikost fondu již změní, požadavek selže se stavovým kódem 409. Když změníte velikost fondu, stav přidělení fondu se změní ze stabilního na změnu velikosti. Velikost fondů nakonfigurovaných pro automatické škálování nejde změnit. Pokud se o to pokusíte, vrátí služba Batch chybu 409. Pokud změníte velikost fondu směrem dolů, služba Batch zvolí, které výpočetní uzly se mají odebrat. Pokud chcete odebrat konkrétní výpočetní uzly, použijte místo toho rozhraní API pro odebrání výpočetních uzlů fondu.

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

With optional parameters:

POST {batchUrl}/pools/{poolId}/resize?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 služby Azure Batch.
poolId	path	True	string	ID fondu, který se má změnit.
api-version	query	True	string	Verze klientského rozhraní API.
timeout	query		integer int32	Maximální čas, který 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	Typ	Description
client-request-id	string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez ozdob, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Jestli má server v odpovědi vrátit client-request-id.
ocp-date	string date-time-rfc1123	Čas, kdy byla žádost vystavena. Klientské knihovny obvykle tuto možnost nastaví na aktuální systémový čas. pokud přímo voláte rozhraní REST API, nastavte ho explicitně.
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čka ETag prostředku ve službě přesně odpovídá hodnotě zadané 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čka ETag prostředku ve službě neodpovídá 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 se provede pouze v případě, že se prostředek ve službě od zadaného času změnil.
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 prostředek ve službě nebyl od zadaného času změněn.

Text požadavku

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

Name	Typ	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Určuje, co dělat s výpočetním uzlem a jeho spuštěnými úlohami, pokud se velikost fondu snižuje. Výchozí hodnota je opětovné zařazení do fronty.
resizeTimeout	string	Časový limit pro přidělení uzlů do fondu nebo odebrání výpočetních uzlů z fondu Výchozí hodnota je 15 minut. Minimální hodnota je 5 minut. Pokud zadáte hodnotu menší než 5 minut, služba Batch vrátí chybu; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (chybný požadavek).
targetDedicatedNodes	integer	Požadovaný počet vyhrazených výpočetních uzlů ve fondu
targetLowPriorityNodes	integer	Požadovaný počet spotových výpočetních uzlů nebo výpočetních uzlů s nízkou prioritou ve fondu

Odpovědi

Name	Typ	Description
202 Accepted		Požadavek na službu Batch byl úspěš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.

Name

Typ

Description

202 Accepted

Požadavek na službu Batch byl úspěš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 kódu ověřování 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 resize

Sample Request

HTTP

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



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

Sample Response

Status code:: 202

Definice

Name	Description
BatchError	Ze služby Azure Batch byla přijata chybová odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.
ComputeNodeDeallocationOption	Určuje, co dělat s výpočetním uzlem a jeho spuštěnými úlohami po jeho výběru pro uvolnění.
ErrorMessage	Chybová zpráva přijatá v Azure Batch odpověď na chybu.
PoolResizeParameter	Možnosti pro změnu velikosti fondu

BatchError

Ze služby Azure Batch byla přijata chybová odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány 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 s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.

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

ComputeNodeDeallocationOption

Určuje, co dělat s výpočetním uzlem a jeho spuštěnými úlohami po jeho výběru pro uvolnění.

Name	Typ	Description
requeue	string	Ukončete spuštěné procesy úloh a znovu zaváděte úlohy do fronty. Jakmile bude k dispozici výpočetní uzel, úlohy se spustí znovu. Odeberte výpočetní uzly hned po ukončení úkolů.
retaineddata	string	Povolte dokončení aktuálně spuštěných úloh a počkejte, až vyprší platnost všech dob uchovávání dat úlohy. Během čekání neplánujte žádné nové úkoly. Odeberte výpočetní uzly, když vypršela doba uchovávání všech úkolů.
taskcompletion	string	Povolte dokončení aktuálně spuštěných úloh. Během čekání neplánujte žádné nové úkoly. Po dokončení všech úloh odeberte výpočetní uzly.
terminate	string	Ukončete spuštěné úlohy. Úkoly budou dokončeny s informací o selhání označující, že byly ukončeny, a nebudou znovu spuštěny. Odeberte výpočetní uzly hned po ukončení úkolů.

ErrorMessage

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

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

PoolResizeParameter

Možnosti pro změnu velikosti fondu

Name	Typ	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Určuje, co dělat s výpočetním uzlem a jeho spuštěnými úlohami, pokud se velikost fondu snižuje. Výchozí hodnota je opětovné zařazení do fronty.
resizeTimeout	string	Časový limit pro přidělení uzlů do fondu nebo odebrání výpočetních uzlů z fondu Výchozí hodnota je 15 minut. Minimální hodnota je 5 minut. Pokud zadáte hodnotu menší než 5 minut, služba Batch vrátí chybu; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (chybný požadavek).
targetDedicatedNodes	integer	Požadovaný počet vyhrazených výpočetních uzlů ve fondu
targetLowPriorityNodes	integer	Požadovaný počet spotových výpočetních uzlů nebo výpočetních uzlů s nízkou prioritou ve fondu

Sdílet prostřednictvím

Pool - Resize

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Authorization

Příklady

Pool resize

Sample Request

Sample Response

Definice

BatchError

BatchErrorDetail

ComputeNodeDeallocationOption

ErrorMessage

PoolResizeParameter

Další materiály