Pool - Evaluate Auto Scale

Usługa:

Batch Service

Wersja interfejsu API:

2024-07-01.20.0

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 {batchUrl}/pools/{poolId}/evaluateautoscale?api-version=2024-07-01.20.0

Z parametrami opcjonalnymi:

POST {batchUrl}/pools/{poolId}/evaluateautoscale?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, na której ma być oceniana formuła automatycznego skalowania.
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.

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. Formuła jest weryfikowana i obliczana jej wyniki, ale nie jest stosowana do puli. Aby zastosować formułę do puli, "Włącz automatyczne skalowanie w puli". Aby uzyskać więcej informacji na temat określania tej formuły, zobacz "Automatyczne skalowanie węzłów obliczeniowych w puli usługi Azure Batch" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AutoScaleRun	Odpowiedź zawierająca wyniki oceny autoskalowania. 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 evaluate autoscale

Przykładowe żądanie

HTTP

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



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

Przykładowa odpowiedź

Kod stanu:

200

{
  "timestamp": "2016-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.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
NameValuePair	Reprezentuje parę nazwa-wartość.
PoolEvaluateAutoScaleParameter	Opcje oceny formuły automatycznego skalowania w puli.

AutoScaleRun

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

Nazwa	Typ	Opis
error	AutoScaleRunError	Szczegóły błędu napotkanego podczas oceniania formuły autoskalowania w puli, jeśli ocena zakończyła się niepowodzeniem.
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	Czas ostatniego oszacowania formuły autoskalowej.

AutoScaleRunError

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

Nazwa	Typ	Opis
code	string	Identyfikator błędu skalowania automatycznego. Kody są niezmienne i mają być używane programowo.
message	string	Komunikat opisujący błąd autoskalowania, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	NameValuePair[]	Lista dodatkowych szczegółów błędu związanych z błędem autoskalowania.

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

ErrorMessage

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.

NameValuePair

Reprezentuje parę nazwa-wartość.

Nazwa	Typ	Opis
name	string	Nazwa w parze name-value.
value	string	Wartość w parze name-value.

PoolEvaluateAutoScaleParameter

Opcje oceny formuły automatycznego skalowania w puli.

Nazwa	Typ	Opis
autoScaleFormula	string	Formuła żądanej liczby węzłów obliczeniowych w puli. Formuła jest weryfikowana i obliczana jej wyniki, ale nie jest stosowana do puli. Aby zastosować formułę do puli, "Włącz automatyczne skalowanie w puli". Aby uzyskać więcej informacji na temat określania tej formuły, zobacz "Automatyczne skalowanie węzłów obliczeniowych w puli usługi Azure Batch" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).