Pool - Remove Nodes
Usuwa węzły obliczeniowe z określonej puli.
Ta operacja może być uruchamiana tylko wtedy, gdy stan alokacji puli jest stały. Po uruchomieniu tej operacji stan alokacji zmienia się ze stałej na zmianę rozmiaru. Każde żądanie może usunąć maksymalnie 100 węzłów.
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 identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
batch
|
path | True |
string |
Podstawowy adres URL wszystkich żądań obsługi Azure Batch. |
pool
|
path | True |
string |
Identyfikator puli, z której chcesz usunąć węzły obliczeniowe. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
timeout
|
query |
integer int32 |
Maksymalny czas, który serwer może poświęcić na przetwarzanie żądania w sekundach. Wartość domyślna to 30 sekund. |
Nagłówek żądania
Media Types: "application/json; odata=minimalmetadata"
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
client-request-id |
string uuid |
Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Czy serwer powinien zwrócić wartość client-request-id w odpowiedzi. |
|
ocp-date |
string date-time-rfc1123 |
Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST. |
|
If-Match |
string |
Wartość ETag skojarzona z wersją zasobu znaną klientowi. Operacja zostanie wykonana tylko wtedy, gdy bieżący element ETag zasobu w usłudze dokładnie odpowiada wartości określonej przez klienta. |
|
If-None-Match |
string |
Wartość ETag skojarzona z wersją zasobu znaną klientowi. Operacja zostanie wykonana tylko wtedy, gdy bieżący element ETag zasobu w usłudze nie jest zgodny z wartością określoną przez klienta. |
|
If-Modified-Since |
string date-time-rfc1123 |
Sygnatura czasowa wskazująca czas ostatniej modyfikacji zasobu znanego klientowi. Operacja zostanie wykonana tylko wtedy, gdy zasób w usłudze został zmodyfikowany od określonego czasu. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Sygnatura czasowa wskazująca czas ostatniej modyfikacji zasobu znanego klientowi. Operacja zostanie wykonana tylko wtedy, gdy zasób w usłudze nie został zmodyfikowany od określonego czasu. |
Treść żądania
Media Types: "application/json; odata=minimalmetadata"
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
nodeList | True |
string[] |
Lista zawierająca identyfikatory węzłów obliczeniowych, które mają zostać usunięte z określonej puli. |
nodeDeallocationOption |
Określa, co zrobić z węzłem obliczeniowym i uruchomionymi zadaniami po wybraniu go do cofnięcia przydziału. |
||
resizeTimeout |
string |
Limit czasu usuwania węzłów obliczeniowych do puli. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
202 Accepted |
Żądanie usługi Batch zakończyło się pomyślnie. Headers
|
|
Other Status Codes |
Błąd usługi Batch. |
Zabezpieczenia
azure_auth
Microsoft Entra przepływ kodu uwierzytelniania OAuth 2.0
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | Personifikuj konto użytkownika |
Authorization
Type:
apiKey
In:
header
Przykłady
Pool remove nodes
Sample Request
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"
]
}
Sample Response
Definicje
Nazwa | Opis |
---|---|
Batch |
Odpowiedź o błędzie odebrana z usługi Azure Batch. |
Batch |
Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu. |
Compute |
Określa, co zrobić z węzłem obliczeniowym i uruchomionymi zadaniami po wybraniu go do cofnięcia przydziału. |
Error |
Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu. |
Node |
Opcje usuwania węzłów obliczeniowych z puli. |
BatchError
Odpowiedź o błędzie odebrana z usługi Azure Batch.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Identyfikator błędu. Kody są niezmienne i mają być używane programowo. |
message |
Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika. |
|
values |
Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu. |
BatchErrorDetail
Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.
Nazwa | Typ | Opis |
---|---|---|
key |
string |
Identyfikator określający znaczenie właściwości Value. |
value |
string |
Dodatkowe informacje zawarte w odpowiedzi na błąd. |
ComputeNodeDeallocationOption
Określa, co zrobić z węzłem obliczeniowym i uruchomionymi zadaniami po wybraniu go do cofnięcia przydziału.
Nazwa | Typ | Opis |
---|---|---|
requeue |
string |
Kończenie uruchamiania procesów zadań i ponowne kolejki zadań. Zadania zostaną uruchomione ponownie po udostępnieniu węzła obliczeniowego. Usuń węzły obliczeniowe po zakończeniu zadań. |
retaineddata |
string |
Zezwalaj na ukończenie aktualnie uruchomionych zadań, a następnie poczekaj na wygaśnięcie wszystkich okresów przechowywania danych zadania. Zaplanuj brak nowych zadań podczas oczekiwania. Usuń węzły obliczeniowe, gdy wszystkie okresy przechowywania zadań wygasły. |
taskcompletion |
string |
Zezwalaj na ukończenie aktualnie uruchomionych zadań. Zaplanuj brak nowych zadań podczas oczekiwania. Usuń węzły obliczeniowe po zakończeniu wszystkich zadań. |
terminate |
string |
Kończenie uruchamiania zadań. Zadania zostaną ukończone z informacją o niepowodzeniu wskazującym, że zostały one zakończone i nie zostaną uruchomione ponownie. Usuń węzły obliczeniowe po zakończeniu zadań. |
ErrorMessage
Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.
Nazwa | Typ | Opis |
---|---|---|
lang |
string |
Kod języka komunikatu o błędzie |
value |
string |
Tekst wiadomości. |
NodeRemoveParameter
Opcje usuwania węzłów obliczeniowych z puli.
Nazwa | Typ | Opis |
---|---|---|
nodeDeallocationOption |
Określa, co zrobić z węzłem obliczeniowym i uruchomionymi zadaniami po wybraniu go do cofnięcia przydziału. |
|
nodeList |
string[] |
Lista zawierająca identyfikatory węzłów obliczeniowych, które mają zostać usunięte z określonej puli. |
resizeTimeout |
string |
Limit czasu usuwania węzłów obliczeniowych do puli. |