Udostępnij za pośrednictwem

Pool - Resize

  • Odwołanie
Usługa:
Batch Service
Wersja interfejsu API:
2024-07-01.20.0

Zmienia liczbę węzłów obliczeniowych przypisanych do puli.
Rozmiar puli można zmienić tylko wtedy, gdy jego stan alokacji jest stały. Jeśli rozmiar puli jest już zmieniany, żądanie kończy się niepowodzeniem z kodem stanu 409. Po zmianie rozmiaru puli stan alokacji puli zmienia się ze stałego na zmianę rozmiaru. Nie można zmienić rozmiaru pul skonfigurowanych do automatycznego skalowania. Jeśli spróbujesz to zrobić, usługa Batch zwróci błąd 409. W przypadku zmiany rozmiaru puli w dół usługa Batch wybierze węzły obliczeniowe do usunięcia. Aby usunąć określone węzły obliczeniowe, zamiast tego użyj interfejsu API usuwania węzłów obliczeniowych puli.

POST {batchUrl}/pools/{poolId}/resize?api-version=2024-07-01.20.0
Z parametrami opcjonalnymi: 
POST {batchUrl}/pools/{poolId}/resize?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 do zmiany rozmiaru.
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 Typ Opis
nodeDeallocationOption

ComputeNodeDeallocationOption

Określa, co zrobić z węzłem obliczeniowym i uruchomionymi zadaniami, jeśli rozmiar puli zostanie zmniejszony.
Wartość domyślna to ponowne kolejki.
resizeTimeout

string (duration)

Limit czasu alokacji węzłów do puli lub usunięcia węzłów obliczeniowych z puli.
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).
targetDedicatedNodes

integer (int32)

Żądana liczba dedykowanych węzłów obliczeniowych w puli.
targetLowPriorityNodes

integer (int32)

Żądana liczba węzłów obliczeniowych typu spot/o niskim priorytcie w puli.

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 resize

Przykładowe żądanie

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



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

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

Opcje zmiany rozmiaru 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.

PoolResizeParameter

Objekt

Opcje zmiany rozmiaru puli.

Nazwa Typ Opis
nodeDeallocationOption

ComputeNodeDeallocationOption

Określa, co zrobić z węzłem obliczeniowym i uruchomionymi zadaniami, jeśli rozmiar puli zostanie zmniejszony.
Wartość domyślna to ponowne kolejki.
resizeTimeout

string (duration)

Limit czasu alokacji węzłów do puli lub usunięcia węzłów obliczeniowych z puli.
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).
targetDedicatedNodes

integer (int32)

Żądana liczba dedykowanych węzłów obliczeniowych w puli.
targetLowPriorityNodes

integer (int32)

Żądana liczba węzłów obliczeniowych typu spot/o niskim priorytcie w puli.