Udostępnij przez

Pools - Evaluate Pool Auto Scale

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

Pobiera wynik oceny formuły automatycznego skalowania w puli.
Ten interfejs API jest przeznaczony głównie do sprawdzania poprawności formuły autoskalowania, ponieważ po prostu zwraca wynik bez stosowania formuły do puli. Pula musi mieć włączone automatyczne skalowanie w celu obliczenia formuły.

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

ID puli, na podstawie której ocenia się formułę automatycznego skalowania.
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.

Treść żądania

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

Nazwa Wymagane Typ Opis
autoScaleFormula True

string

Formuła żądanej liczby węzłów obliczeniowych w puli. Wzór jest walidowany, a jego wyniki obliczane, ale nie jest stosowany do Pool. Aby zastosować wzór do puli, należy 'Włącz automatyczne skalowanie na puli'. Więcej informacji o określaniu tego wzoru można znaleźć w artykule Automatycznie skalować węzły obliczeniowe w Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Odpowiedzi

Nazwa Typ Opis
200 OK

AutoScaleRun

Żą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 evaluate autoscale

Przykładowe żądanie

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



{
  "autoScaleFormula": "$TargetDedicated=1"
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "timestamp": "2025-11-22T19:39:28.5246331Z",
  "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}

Definicje

Nazwa Opis
AutoScaleRun

Wyniki i błędy z wykonania formuły autoskalowania puli.
AutoScaleRunError

Wystąpił błąd podczas wykonywania lub obliczania formuły autoskalowania puli.
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.
BatchPoolEvaluateAutoScaleOptions

Parametry oceny formuły automatycznego skalowania w puli usługi Azure Batch.
NameValuePair

Reprezentuje parę nazwa-wartość.

AutoScaleRun

Objekt

Wyniki i błędy z wykonania formuły autoskalowania puli.

Nazwa Typ Opis
error

AutoScaleRunError

Szczegóły błędu napotkanego podczas oceny formuły autoscale na puli, jeśli ocena nie powiodła się.
results

string

Końcowe wartości wszystkich zmiennych używanych w ocenie formuły autoskalowania. Każda wartość zmiennej jest zwracana w formularzu $variable=wartość, a zmienne są rozdzielane średnikami.
timestamp

string (date-time)

Czas ostatniego oszacowania formuły autoskalowej.

AutoScaleRunError

Objekt

Wystąpił błąd podczas wykonywania lub obliczania formuły autoskalowania puli.

Nazwa Typ Opis
code

string

Identyfikator błędu autoscale. Kody są niezmienne i mają być używane programowo.
message

string

Komunikat opisujący błąd autoscale, przeznaczony do wyświetlania w interfejsie użytkownika.
values

NameValuePair[]

Lista dodatkowych szczegółów dotyczących błędu autoscale.

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.

BatchPoolEvaluateAutoScaleOptions

Objekt

Parametry oceny formuły automatycznego skalowania w puli usługi Azure Batch.

Nazwa Typ Opis
autoScaleFormula

string

Formuła żądanej liczby węzłów obliczeniowych w puli. Wzór jest walidowany, a jego wyniki obliczane, ale nie jest stosowany do Pool. Aby zastosować wzór do puli, należy 'Włącz automatyczne skalowanie na puli'. Więcej informacji o określaniu tego wzoru można znaleźć w artykule Automatycznie skalować węzły obliczeniowe w Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

NameValuePair

Objekt

Reprezentuje parę nazwa-wartość.

Nazwa Typ Opis
name

string

Nazwa w parze imię-wartość.
value

string

Wartość w parze imię-wartość.