Pool - Enable Auto Scale

  • Ссылка
Service:
Batch Service
API Version:
2023-11-01.18.0

Включает автоматическое масштабирование для пула.
Вы не можете включить автоматическое масштабирование в пуле, если в пуле выполняется операция изменения размера. Если автоматическое масштабирование пула в настоящее время отключено, необходимо указать допустимую формулу автомасштабирования в рамках запроса. Если автоматическое масштабирование пула уже включено, можно указать новую формулу автомасштабирования и (или) новый интервал оценки. Вы не можете вызывать этот API для одного и того же пула более одного раза в 30 секунд.

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/enableautoscale?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 напрямую.
If-Match

string

Значение ETag, связанное с версией ресурса, известной клиенту. Операция будет выполняться только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
If-None-Match

string

Значение ETag, связанное с версией ресурса, известной клиенту. Операция будет выполняться только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
If-Modified-Since

string

date-time-rfc1123

Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполняться только в том случае, если ресурс в службе был изменен с указанного времени.
If-Unmodified-Since

string

date-time-rfc1123

Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполняться только в том случае, если ресурс в службе не был изменен с указанного времени.

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

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

Имя Тип Описание
autoScaleEvaluationInterval

string

Интервал времени для автоматической настройки размера пула в соответствии с формулой автомасштабирования.
Значение по умолчанию — 15 минут. Минимальное и максимальное значения — 5 минут и 168 часов соответственно. Если указать значение меньше 5 минут или больше 168 часов, пакетная служба отклоняет запрос с ошибкой недопустимого значения свойства; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос). Если указать новый интервал, то существующее расписание оценки автомасштабирования будет остановлено и будет запущено новое расписание оценки автомасштабирования, а его начальным временем является время выдачи этого запроса.
autoScaleFormula

string

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

Ответы

Имя Тип Описание
200 OK

Запрос к пакетной службе выполнен успешно.

Headers

  • 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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Pool enable autoscale

Sample Request

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



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Sample Response

Status code:
200

Определения

Имя Описание
BatchError

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

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

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

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

BatchError

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

Имя Тип Описание
code

string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message

ErrorMessage

Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.
values

BatchErrorDetail[]

Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

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

Имя Тип Описание
key

string

Идентификатор, указывающий значение свойства Value.
value

string

Дополнительные сведения, включенные в ответ об ошибке.

ErrorMessage

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

Имя Тип Описание
lang

string

Код языка сообщения об ошибке
value

string

Текст сообщения.

PoolEnableAutoScaleParameter

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

Имя Тип Описание
autoScaleEvaluationInterval

string

Интервал времени для автоматической настройки размера пула в соответствии с формулой автомасштабирования.
Значение по умолчанию — 15 минут. Минимальное и максимальное значения — 5 минут и 168 часов соответственно. Если указать значение меньше 5 минут или больше 168 часов, пакетная служба отклоняет запрос с ошибкой недопустимого значения свойства; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос). Если указать новый интервал, то существующее расписание оценки автомасштабирования будет остановлено и будет запущено новое расписание оценки автомасштабирования, а его начальным временем является время выдачи этого запроса.
autoScaleFormula

string

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