Pool - Evaluate Auto Scale
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, aby można było ocenić formułę.
POST {batchUrl}/pools/{poolId}/evaluateautoscale?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/evaluateautoscale?timeout={timeout}&api-version=2023-11-01.18.0
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
batch
|
path | True |
string |
Podstawowy adres URL dla wszystkich żądań obsługi Azure Batch. |
pool
|
path | True |
string |
Identyfikator puli, dla 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. |
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. |
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. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Odpowiedź zawierająca wyniki oceny autoskalowania. Headers
|
|
Other Status Codes |
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 evaluate autoscale
Sample Request
POST account.region.batch.azure.com/pools/poolId/evaluateautoscale?api-version=2023-11-01.18.0
{
"autoScaleFormula": "$TargetDedicated=1"
}
Sample Response
{
"timestamp": "2016-11-22T19:39:28.5246331Z",
"results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}
Definicje
Nazwa | Opis |
---|---|
Auto |
Wyniki i błędy podczas wykonywania formuły autoskalowania puli. |
Auto |
Wystąpił błąd podczas wykonywania lub oceniania formuły autoskalowania puli. |
Batch |
Odebrano odpowiedź o błędzie z usługi Azure Batch. |
Batch |
Element dodatkowych informacji zawartych w odpowiedzi na błąd Azure Batch. |
Error |
Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu. |
Name |
Reprezentuje parę nazwa-wartość. |
Pool |
Opcje oceny formuły automatycznego skalowania w puli. |
AutoScaleRun
Wyniki i błędy podczas wykonywania formuły autoskalowania puli.
Nazwa | Typ | Opis |
---|---|---|
error |
Szczegóły błędu napotkanego podczas oceniania formuły autoskalowania w puli, jeśli ocena nie powiodła się. |
|
results |
string |
Końcowe wartości wszystkich zmiennych używanych w ocenie formuły autoskalowania. |
timestamp |
string |
Czas ostatniego obliczenia formuły autoskalu. |
AutoScaleRunError
Wystąpił błąd podczas wykonywania lub oceniania 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 |
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 |
Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika. |
|
values |
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. |
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. |