Pool - Evaluate Auto Scale

Служба:

Batch Service

Версия API:

2023-11-01.18.0

Возвращает результат вычисления формулы автоматического масштабирования в пуле.
Этот API в первую очередь предназначен для проверки формулы автомасштабирования, так как он просто возвращает результат без применения формулы к пулу. Для вычисления формулы в пуле должно быть включено автоматическое масштабирование.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.
poolId	path	True	string	Идентификатор пула, в котором вычисляет формулу автоматического масштабирования.
api-version	query	True	string	Версия API клиента.
timeout	query		integer int32	Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 30 секунд.

Заголовок запроса

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

Имя	Обязательно	Тип	Описание
client-request-id		string uuid	Удостоверение запроса, созданное вызывающим абонентом, в виде GUID без оформления, например фигурных скобок, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Указывает, должен ли сервер возвращать client-request-id в ответе.
ocp-date		string date-time-rfc1123	Время отправки запроса. Клиентские библиотеки обычно устанавливают текущее системное время; Задайте его явным образом, если вы вызываете REST API напрямую.

Текст запроса

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

Имя	Обязательно	Тип	Описание
autoScaleFormula	True	string	Формула для требуемого числа вычислительных узлов в пуле. Формула проверяется и вычисляется ее результаты, но не применяется к пулу. Чтобы применить формулу к пулу, включите автоматическое масштабирование в пуле. Дополнительные сведения об указании этой формулы см. в статье Автоматическое масштабирование вычислительных узлов в пуле пакетная служба Azure (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Ответы

Имя	Тип	Описание
200 OK	AutoScaleRun	Ответ, содержащий результаты оценки автомасштабирования. Заголовки client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Ошибка пакетной службы.

Безопасность

azure_auth

Microsoft Entra поток кода проверки подлинности OAuth 2.0

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	Олицетворение учетной записи пользователя

Authorization

Тип: apiKey
В: header

Примеры

Pool evaluate autoscale

Образец запроса

HTTP

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



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

Пример ответа

Код состояния:

200

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

Определения

Имя	Описание
AutoScaleRun	Результаты и ошибки при выполнении формулы автомасштабирования пула.
AutoScaleRunError	Ошибка, которая произошла при выполнении или оценке формулы автомасштабирования пула.
BatchError	Ответ об ошибке, полученный от службы пакетная служба Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
ErrorMessage	Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
NameValuePair	Представляет пару "имя-значение".
PoolEvaluateAutoScaleParameter	Параметры для оценки формулы автоматического масштабирования в пуле.

AutoScaleRun

Результаты и ошибки при выполнении формулы автомасштабирования пула.

Имя	Тип	Описание
error	AutoScaleRunError	Сведения об ошибке при вычислении формулы автомасштабирования в пуле, если оценка не удалась.
results	string	Конечные значения всех переменных, используемых при вычислении формулы автомасштабирования. Каждое значение переменной возвращается в форме $variable=значение, а переменные разделяются точкой с запятой.
timestamp	string	Время последней оценки формулы автомасштабирования.

AutoScaleRunError

Ошибка, которая произошла при выполнении или оценке формулы автомасштабирования пула.

Имя	Тип	Описание
code	string	Идентификатор ошибки автомасштабирования. Коды инвариантны и предназначены для программного использования.
message	string	Сообщение, описывающее ошибку автомасштабирования, предназначенную для отображения в пользовательском интерфейсе.
values	NameValuePair[]	Список дополнительных сведений об ошибках, связанных с ошибкой автомасштабирования.

BatchError

Ответ об ошибке, полученный от службы пакетная служба Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message	ErrorMessage	Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ об ошибке.

ErrorMessage

Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.

Имя	Тип	Описание
lang	string	Код языка сообщения об ошибке
value	string	Текст сообщения.

NameValuePair

Представляет пару "имя-значение".

Имя	Тип	Описание
name	string	Имя в паре "имя-значение".
value	string	Значение в паре "имя-значение".

PoolEvaluateAutoScaleParameter

Параметры для оценки формулы автоматического масштабирования в пуле.

Имя	Тип	Описание
autoScaleFormula	string	Формула для требуемого числа вычислительных узлов в пуле. Формула проверяется и вычисляется ее результаты, но не применяется к пулу. Чтобы применить формулу к пулу, включите автоматическое масштабирование в пуле. Дополнительные сведения об указании этой формулы см. в статье Автоматическое масштабирование вычислительных узлов в пуле пакетная служба Azure (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).