Pool - Enable Auto Scale

Service:

Batch Service

API Version:

2023-11-01.18.0

Umożliwia 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 na 30 sekund.

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2023-11-01.18.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań obsługi Azure Batch.
poolId	path	True	string	Identyfikator puli, w której ma być włączone automatyczne skalowanie.
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.

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, takich jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Określa, 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ść elementu ETag skojarzona z wersją zasobu znanego 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 znanego klientowi. Operacja zostanie wykonana tylko wtedy, gdy bieżący element ETag zasobu w usłudze jest niezgodny 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
autoScaleEvaluationInterval	string	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 interwał, istniejący harmonogram oceny skalowania automatycznego zostanie zatrzymany i zostanie uruchomiony nowy harmonogram oceny skalowania automatycznego, a jego czas rozpoczęcia to czas wystawienia tego żądania.
autoScaleFormula	string	Formuła żądanej liczby węzłów obliczeniowych w puli. Formuła jest sprawdzana pod kątem ważności przed zastosowaniem jej do puli. Jeśli formuła jest nieprawidłowa, usługa Batch odrzuca żądanie ze szczegółowymi informacjami o błędzie. Aby uzyskać więcej informacji na temat określania tej formuły, zobacz Automatyczne skalowanie węzłów obliczeniowych w puli Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Odpowiedzi

Nazwa	Typ	Opis
200 OK		Żądanie do usługi Batch zakończyło się pomyślnie. Headers 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

przepływ kodu uwierzytelniania OAuth 2.0 Microsoft Entra

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

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2023-11-01.18.0



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

Sample Response

Status code:

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 Azure Batch.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.
PoolEnableAutoScaleParameter	Opcje włączania automatycznego skalowania w puli.

BatchError

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

Element dodatkowych informacji zawartych w odpowiedzi na błąd 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.

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.

PoolEnableAutoScaleParameter

Opcje włączania automatycznego skalowania w puli.

Nazwa	Typ	Opis
autoScaleEvaluationInterval	string	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 interwał, istniejący harmonogram oceny skalowania automatycznego zostanie zatrzymany i zostanie uruchomiony nowy harmonogram oceny skalowania automatycznego, a jego czas rozpoczęcia to czas wystawienia tego żądania.
autoScaleFormula	string	Formuła żądanej liczby węzłów obliczeniowych w puli. Formuła jest sprawdzana pod kątem ważności przed zastosowaniem jej do puli. Jeśli formuła jest nieprawidłowa, usługa Batch odrzuca żądanie ze szczegółowymi informacjami o błędzie. Aby uzyskać więcej informacji na temat określania tej formuły, zobacz Automatyczne skalowanie węzłów obliczeniowych w puli Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).