Pool - Enable Auto Scale

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

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2020-09-01.12.0
POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2020-09-01.12.0

Параметры URI

Name In Required Type Description
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"

Name Required Type Description
client-request-id
  • string
uuid

Формируемый вызывающим объектом идентификатор запроса в виде идентификатора GUID без декорирования, например фигурных скобок, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id
  • boolean

Должен ли сервер возвращать в ответе клиент-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"

Name Type Description
autoScaleEvaluationInterval
  • string

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

autoScaleFormula
  • string

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

Ответы

Name Type Description
200 OK

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

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

Ошибка пакетной службы.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Pool enable autoscale

Sample Request

POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Sample Response

Определения

BatchError

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

BatchErrorDetail

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

ErrorMessage

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

PoolEnableAutoScaleParameter

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

BatchError

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

Name Type Description
code
  • string

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

message

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

values

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

BatchErrorDetail

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

Name Type Description
key
  • string

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

value
  • string

Дополнительные сведения, содержащиеся в ответе на ошибку.

ErrorMessage

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

Name Type Description
lang
  • string

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

value
  • string

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

PoolEnableAutoScaleParameter

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

Name Type Description
autoScaleEvaluationInterval
  • string

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

autoScaleFormula
  • string

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