Pool - Remove Nodes

Usługa:

Batch Service

Wersja interfejsu API:

2024-07-01.20.0

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łego na zmianę rozmiaru. Każde żądanie może usunąć maksymalnie 100 węzłów.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań usługi Azure Batch.
poolId	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 przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta wartość domyślna.

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ć identyfikator żądania klienta 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ść elementu 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ść elementu 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 usługi 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. Na żądanie można usunąć maksymalnie 100 węzłów.
nodeDeallocationOption		ComputeNodeDeallocationOption	Określa, co należy zrobić z węzłem obliczeniowym i uruchomionymi zadaniami po wybraniu go do cofnięcia przydziału. Wartość domyślna to ponowne kolejki.
resizeTimeout		string (duration)	Limit czasu usuwania węzłów obliczeniowych z pulą. Wartość domyślna to 15 minut. Minimalna wartość to 5 minut. Jeśli określisz wartość mniejszą niż 5 minut, usługa Batch zwróci błąd; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie).

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie do usługi Batch zakończyło się pomyślnie. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra OAuth 2.0 — przepływ kodu uwierzytelniania

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Typ: apiKey
W: header

Przykłady

Pool remove nodes

Przykładowe żądanie

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"
  ]
}

Przykładowa odpowiedź

Kod stanu:

202

Definicje

Nazwa	Opis
BatchError	Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.
ComputeNodeDeallocationOption	Określa, co należy zrobić z węzłem obliczeniowym i uruchomionymi zadaniami po wybraniu go do cofnięcia przydziału.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
NodeRemoveParameter	Opcje usuwania węzłów obliczeniowych z puli.

BatchError

Objekt

Odebrano odpowiedź o błędzie z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Objekt

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.

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

Wyliczanie

Określa, co należy zrobić z węzłem obliczeniowym i uruchomionymi zadaniami po wybraniu go do cofnięcia przydziału.

Wartość	Opis
requeue	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 natychmiast po zakończeniu zadań.
retaineddata	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	Zezwalaj na ukończenie aktualnie uruchomionych zadań. Zaplanuj brak nowych zadań podczas oczekiwania. Usuń węzły obliczeniowe po zakończeniu wszystkich zadań.
terminate	Kończenie uruchamiania zadań. Zadania zostaną ukończone z informacją o niepowodzeniu wskazującym, że zostały zakończone i nie zostaną uruchomione ponownie. Usuń węzły obliczeniowe natychmiast po zakończeniu zadań.

ErrorMessage

Objekt

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.

NodeRemoveParameter

Objekt

Opcje usuwania węzłów obliczeniowych z puli.

Nazwa	Typ	Opis
nodeDeallocationOption	ComputeNodeDeallocationOption	Określa, co należy zrobić z węzłem obliczeniowym i uruchomionymi zadaniami po wybraniu go do cofnięcia przydziału. Wartość domyślna to ponowne kolejki.
nodeList	string[]	Lista zawierająca identyfikatory węzłów obliczeniowych, które mają zostać usunięte z określonej puli. Na żądanie można usunąć maksymalnie 100 węzłów.
resizeTimeout	string (duration)	Limit czasu usuwania węzłów obliczeniowych z pulą. Wartość domyślna to 15 minut. Minimalna wartość to 5 minut. Jeśli określisz wartość mniejszą niż 5 minut, usługa Batch zwróci błąd; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie).