Pool - Enable Auto Scale
Включает автоматическое масштабирование для пула.
Вы не можете включить автоматическое масштабирование в пуле, если в пуле выполняется операция изменения размера. Если автоматическое масштабирование пула в настоящее время отключено, необходимо указать допустимую формулу автомасштабирования в рамках запроса. Если автоматическое масштабирование пула уже включено, можно указать новую формулу автомасштабирования и (или) новый интервал оценки. Вы не можете вызывать этот API для одного и того же пула более одного раза в 30 секунд.
POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2023-11-01.18.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure. |
pool
|
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 |
Интервал времени для автоматической настройки размера пула в соответствии с формулой автомасштабирования. |
autoScaleFormula |
string |
Формула для требуемого числа вычислительных узлов в пуле. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Запрос к пакетной службе выполнен успешно. Заголовки
|
|
Other Status Codes |
Ошибка пакетной службы. |
Безопасность
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=2023-11-01.18.0
{
"autoScaleFormula": "$TargetDedicated=0",
"autoScaleEvaluationInterval": "PT8M"
}
Пример ответа
Определения
Имя | Описание |
---|---|
Batch |
Ответ об ошибке, полученный от службы пакетная служба Azure. |
Batch |
Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure. |
Error |
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure. |
Pool |
Параметры для включения автоматического масштабирования в пуле. |
BatchError
Ответ об ошибке, полученный от службы пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды инвариантны и предназначены для программного использования. |
message |
Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе. |
|
values |
Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке. |
BatchErrorDetail
Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
key |
string |
Идентификатор, указывающий значение свойства Value. |
value |
string |
Дополнительные сведения, включенные в ответ об ошибке. |
ErrorMessage
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
lang |
string |
Код языка сообщения об ошибке |
value |
string |
Текст сообщения. |
PoolEnableAutoScaleParameter
Параметры для включения автоматического масштабирования в пуле.
Имя | Тип | Описание |
---|---|---|
autoScaleEvaluationInterval |
string |
Интервал времени для автоматической настройки размера пула в соответствии с формулой автомасштабирования. |
autoScaleFormula |
string |
Формула для требуемого числа вычислительных узлов в пуле. |