Pool - Enable Auto Scale

  • Ссылка
Служба:
Batch Service
Версия API:
2024-07-01.20.0

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

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2024-07-01.20.0
С использованием необязательных параметров: 
POST {batchUrl}/pools/{poolId}/enableautoscale?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 напрямую.
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/documentation/articles/batch-automatic-scaling).

Ответы

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

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

Заголовки

  • 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 enable autoscale

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

POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2024-07-01.20.0



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

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

Код состояния:
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/documentation/articles/batch-automatic-scaling).