Pools - Evaluate Pool Auto Scale

Служба:

Batch Service

Версия API:

2025-06-01

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

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
poolId	path	True	string	ID пула, на котором оценивается формула автоматического масштабирования.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
timeOut	query		integer (int32)	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

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

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

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

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

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

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

Ответы

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

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

OAuth2Auth

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

Области

Имя	Описание
https://batch.core.windows.net//.default

Примеры

Pool evaluate autoscale

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

HTTP

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



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

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

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

200

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

Определения

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

AutoScaleRun

Объект

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

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

AutoScaleRunError

Объект

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

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

BatchError

Объект

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

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

BatchErrorDetail

Объект

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

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

BatchErrorMessage

Объект

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

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

BatchPoolEvaluateAutoScaleOptions

Объект

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

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

NameValuePair

Объект

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

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