Pool - Remove Nodes
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í. Při spuštění této operace se stav přidělení změní ze stabilního na změnu velikosti. Každý požadavek může odebrat až 100 uzlů.
POST {batchUrl}/pools/{poolId}/removenodes?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/removenodes?timeout={timeout}&api-version=2023-11-01.18.0
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Základní adresa URL pro všechny požadavky služby Azure Batch. |
pool
|
path | True |
string |
ID fondu, ze kterého chcete odebrat výpočetní uzly. |
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 | Vyžadováno | 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 | 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. |
nodeDeallocationOption |
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í. |
||
resizeTimeout |
string |
Časový limit pro odebrání výpočetních uzlů do fondu |
Odpovědi
Name | Typ | Description |
---|---|---|
202 Accepted |
Požadavek na službu Batch byl úspěšný. Hlavičky
|
|
Other Status Codes |
Chyba ze služby Batch. |
Zabezpečení
azure_auth
Microsoft Entra tok kódu ověřování 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
POST account.region.batch.azure.com/pools/poolId/removenodes?api-version=2023-11-01.18.0
{
"nodeList": [
"tvm-1695681911_1-20161122t224741z",
"tvm-1695681911_2-20161122t224741z"
]
}
Ukázková odpověď
Definice
Name | Description |
---|---|
Batch |
Ze služby Azure Batch byla přijata chybová odpověď. |
Batch |
Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu. |
Compute |
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í. |
Error |
Chybová zpráva přijatá v Azure Batch odpověď na chybu. |
Node |
Možnosti odebrání výpočetních uzlů z 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 |
Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní. |
|
values |
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. |
NodeRemoveParameter
Možnosti odebrání výpočetních uzlů z fondu
Name | Typ | Description |
---|---|---|
nodeDeallocationOption |
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í. |
|
nodeList |
string[] |
Seznam obsahující ID výpočetních uzlů, které se mají odebrat ze zadaného fondu. |
resizeTimeout |
string |
Časový limit pro odebrání výpočetních uzlů do fondu |