Pool - Remove Nodes

Služba:

Batch Service

Verze rozhraní API:

2024-07-01.20.0

Odebere výpočetní uzly ze zadaného fondu.
Tato operace se může spustit pouze v případě, že je stav přidělení fondu stabilní. Po spuštění této operace se stav přidělení změní z stabilní na změnu velikosti. Každý požadavek může odebrat až 100 uzlů.

POST {batchUrl}/pools/{poolId}/removenodes?api-version=2024-07-01.20.0

S volitelnými parametry:

POST {batchUrl}/pools/{poolId}/removenodes?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, ze kterého chcete odebrat výpočetní uzly.
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	Vyžadováno	Typ	Description
nodeList	True	string[]	Seznam obsahující ID výpočetních uzlů, které se mají odebrat ze zadaného fondu. Na požadavek může být odebráno maximálně 100 uzlů.
nodeDeallocationOption		ComputeNodeDeallocationOption	Určuje, co se má dělat s výpočetním uzlem a jeho spuštěnými úlohami po výběru pro uvolnění. Výchozí hodnota je znovu vyměněná.
resizeTimeout		string (duration)	Časový limit pro odebrání výpočetních uzlů do fondu Výchozí hodnota je 15 minut. Minimální hodnota je 5 minut. Pokud zadáte hodnotu kratší než 5 minut, služba Batch vrátí chybu; Pokud voláte přímo rozhraní REST API, stavový kód HTTP je 400 (chybný požadavek).

Odpovědi

Name	Typ	Description
202 Accepted		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 remove nodes

Ukázkový požadavek

HTTP

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



{
  "nodeList": [
    "tvm-1695681911_1-20161122t224741z",
    "tvm-1695681911_2-20161122t224741z"
  ]
}

Ukázková odpověď

Stavový kód:

202

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
ComputeNodeDeallocationOption	Určuje, co se má dělat s výpočetním uzlem a jeho spuštěnými úlohami po výběru pro uvolnění.
ErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
NodeRemoveParameter	Možnosti pro odebrání výpočetních uzlů z fondu

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

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.

ComputeNodeDeallocationOption

Výčet

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

Hodnota	Description
requeue	Ukončete spuštěné procesy úloh a znovu zadejte do fronty úkoly. Úkoly se spustí znovu, jakmile bude k dispozici výpočetní uzel. Jakmile budou úkoly ukončeny, odeberte výpočetní uzly.
retaineddata	Povolte dokončení aktuálně spuštěných úkolů a počkejte na vypršení platnosti všech období uchovávání dat úkolů. Při čekání neplánujte žádné nové úkoly. Pokud vypršela platnost všech období uchovávání úkolů, odeberte výpočetní uzly.
taskcompletion	Povolit dokončení aktuálně spuštěných úkolů Při čekání neplánujte žádné nové úkoly. Po dokončení všech úkolů odeberte výpočetní uzly.
terminate	Ukončete spuštěné úkoly. Úkoly budou dokončeny s informacemi o selhání, které indikují, že byly ukončeny, a nebudou znovu spuštěny. Jakmile budou úkoly ukončeny, odeberte výpočetní uzly.

ErrorMessage

Objekt

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.

NodeRemoveParameter

Objekt

Možnosti pro odebrání výpočetních uzlů z fondu

Name	Typ	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Určuje, co se má dělat s výpočetním uzlem a jeho spuštěnými úlohami po výběru pro uvolnění. Výchozí hodnota je znovu vyměněná.
nodeList	string[]	Seznam obsahující ID výpočetních uzlů, které se mají odebrat ze zadaného fondu. Na požadavek může být odebráno maximálně 100 uzlů.
resizeTimeout	string (duration)	Časový limit pro odebrání výpočetních uzlů do fondu Výchozí hodnota je 15 minut. Minimální hodnota je 5 minut. Pokud zadáte hodnotu kratší než 5 minut, služba Batch vrátí chybu; Pokud voláte přímo rozhraní REST API, stavový kód HTTP je 400 (chybný požadavek).