Udostępnij przez

Pools - Remove Nodes

Usługa:
Batch Service
Wersja interfejsu API:
2025-06-01

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 {endpoint}/pools/{poolId}/removenodes?api-version=2025-06-01
Z parametrami opcjonalnymi: 
POST {endpoint}/pools/{poolId}/removenodes?api-version=2025-06-01&timeOut={timeOut}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
 path True

string (uri)

Punkt końcowy konta usługi Batch (na przykład: https://batchaccount.eastus2.batch.azure.com).
poolId
 path True

string

Identyfikator puli do pobrania.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.
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 domyślna wersja domyślna.".

Nagłówek żądania

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

Nazwa Wymagane Typ Opis
client-request-id

string

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

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

string (date-time-rfc7231)

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

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

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

BatchNodeDeallocationOption

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 zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone.

Nagłówki

  • DataServiceId: string
  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

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

Zakresy

Nazwa Opis
https://batch.core.windows.net//.default

Przykłady

Pool remove nodes

Przykładowe żądanie

POST {endpoint}/pools/poolId/removenodes?api-version=2025-06-01



{
  "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.
BatchErrorMessage

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

Enumy BatchNodeDeallocationOption
BatchNodeRemoveOptions

Parametry usuwania węzłów z puli usługi Azure Batch.

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

BatchErrorMessage

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.

BatchErrorMessage

Objekt

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

Nazwa Typ Opis
lang

string

Kod językowy komunikatu o błędzie.
value

string

Tekst wiadomości.

BatchNodeDeallocationOption

Wyliczenie

Enumy BatchNodeDeallocationOption

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ń.
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ń.
taskcompletion

Zezwalaj na ukończenie aktualnie uruchomionych zadań. Zaplanuj brak nowych zadań podczas oczekiwania. Usuń węzły obliczeniowe po zakończeniu wszystkich zadań.
retaineddata

Przestarzałe, zachęcamy do przekazywania danych zadania do usługi Azure Storage w zadaniu i używania TaskCompletion zamiast niego. 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.

BatchNodeRemoveOptions

Objekt

Parametry usuwania węzłów z puli usługi Azure Batch.

Nazwa Typ Opis
nodeDeallocationOption

BatchNodeDeallocationOption

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