Udostępnij przez

Pools - Enable Pool Auto Scale

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

Włącza automatyczne skalowanie dla puli.
Nie można włączyć automatycznego skalowania w puli, jeśli operacja zmiany rozmiaru jest w toku w puli. Jeśli automatyczne skalowanie puli jest obecnie wyłączone, należy określić prawidłową formułę autoskalowania w ramach żądania. Jeśli automatyczne skalowanie puli jest już włączone, możesz określić nową formułę autoskalowania i/lub nowy interwał oceny. Nie można wywołać tego interfejsu API dla tej samej puli więcej niż raz co 30 sekund.

POST {endpoint}/pools/{poolId}/enableautoscale?api-version=2025-06-01
Z parametrami opcjonalnymi: 
POST {endpoint}/pools/{poolId}/enableautoscale?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 Typ Opis
autoScaleEvaluationInterval

string (duration)

Interwał czasu, w którym ma być automatycznie dostosowywany rozmiar puli zgodnie z formułą autoskalowania. Wartość domyślna to 15 minut. Minimalna i maksymalna wartość to odpowiednio 5 minut i 168 godzin. Jeśli określisz wartość mniejszą niż 5 minut lub większą niż 168 godzin, usługa Batch odrzuci żądanie z nieprawidłowym błędem wartości właściwości; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie). Jeśli określisz nowy przedział, istniejący harmonogram oceny autoskali zostanie zatrzymany, a rozpocznie się nowy harmonogram oceny autoskalowania, którego czas rozpoczęcia to będzie w momencie wysłania tego żądania.
autoScaleFormula

string

Formuła żądanej liczby węzłów obliczeniowych w puli. Wartość domyślna to 15 minut. Minimalna i maksymalna wartość to odpowiednio 5 minut i 168 godzin. Jeśli określisz wartość mniejszą niż 5 minut lub większą niż 168 godzin, usługa Batch odrzuci żądanie z nieprawidłowym błędem wartości właściwości; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie). Jeśli określisz nowy przedział, istniejący harmonogram oceny autoskali zostanie zatrzymany, a rozpocznie się nowy harmonogram oceny autoskalowania, którego czas rozpoczęcia to będzie w momencie wysłania tego żądania.

Odpowiedzi

Nazwa Typ Opis
200 OK

Żądanie zakończyło się pomyślnie.

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 enable autoscale

Przykładowe żądanie

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



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Przykładowa odpowiedź

Kod stanu:
200

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

Parametry umożliwiające automatyczne skalowanie w 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.

BatchPoolEnableAutoScaleOptions

Objekt

Parametry umożliwiające automatyczne skalowanie w puli usługi Azure Batch.

Nazwa Typ Opis
autoScaleEvaluationInterval

string (duration)

Interwał czasu, w którym ma być automatycznie dostosowywany rozmiar puli zgodnie z formułą autoskalowania. Wartość domyślna to 15 minut. Minimalna i maksymalna wartość to odpowiednio 5 minut i 168 godzin. Jeśli określisz wartość mniejszą niż 5 minut lub większą niż 168 godzin, usługa Batch odrzuci żądanie z nieprawidłowym błędem wartości właściwości; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie). Jeśli określisz nowy przedział, istniejący harmonogram oceny autoskali zostanie zatrzymany, a rozpocznie się nowy harmonogram oceny autoskalowania, którego czas rozpoczęcia to będzie w momencie wysłania tego żądania.
autoScaleFormula

string

Formuła żądanej liczby węzłów obliczeniowych w puli. Wartość domyślna to 15 minut. Minimalna i maksymalna wartość to odpowiednio 5 minut i 168 godzin. Jeśli określisz wartość mniejszą niż 5 minut lub większą niż 168 godzin, usługa Batch odrzuci żądanie z nieprawidłowym błędem wartości właściwości; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie). Jeśli określisz nowy przedział, istniejący harmonogram oceny autoskali zostanie zatrzymany, a rozpocznie się nowy harmonogram oceny autoskalowania, którego czas rozpoczęcia to będzie w momencie wysłania tego żądania.