Pool - Evaluate Auto Scale

Служба:

Batch Service

Версия API:

2024-07-01.20.0

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

POST {batchUrl}/pools/{poolId}/evaluateautoscale?api-version=2024-07-01.20.0

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

POST {batchUrl}/pools/{poolId}/evaluateautoscale?timeout={timeout}&api-version=2024-07-01.20.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов пакетной службы Azure.
poolId	path	True	string	Идентификатор пула, на котором выполняется оценка формулы автоматического масштабирования.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
timeout	query		integer int32	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 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://learn.microsoft.com/azure/batch/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=2024-07-01.20.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=value, а переменные разделяются точкой с запятой.
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://learn.microsoft.com/azure/batch/batch-automatic-scaling).