Pools - Resize Pool

Служба:

Batch Service

Версия API:

2025-06-01

Изменяет количество вычислительных узлов, назначенных пулу.
Изменить размер пула можно только в том случае, если состояние выделения устойчиво. Если пул уже изменяется, запрос завершается ошибкой с кодом состояния 409. При изменении размера пула состояние выделения пула изменяется от устойчивого к изменению размера. Невозможно изменить размер пулов, настроенных для автоматического масштабирования. При попытке сделать это служба пакетной службы возвращает ошибку 409. Если изменить размер пула вниз, служба пакетной службы выбирает, какие вычислительные узлы следует удалить. Чтобы удалить определенные вычислительные узлы, используйте вместо этого API вычислительных узлов пула.

POST {endpoint}/pools/{poolId}/resize?api-version=2025-06-01

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

POST {endpoint}/pools/{poolId}/resize?api-version=2025-06-01&timeOut={timeOut}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
poolId	path	True	string	Идентификатор пула, который требуется получить.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
timeOut	query		integer (int32)	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

Заголовок запроса

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

Имя	Обязательно	Тип	Описание
client-request-id		string	Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date		string (date-time-rfc7231)	Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.
If-Modified-Since		string (date-time-rfc7231)	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
If-Unmodified-Since		string (date-time-rfc7231)	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс в службе не был изменен с указанного времени.
If-Match		string	Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
If-None-Match		string	Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.

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

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

Имя	Тип	Описание
nodeDeallocationOption	BatchNodeDeallocationOption	Определяет, что делать с вычислительным узлом и его выполняемыми задачами, если размер пула уменьшается. Значение по умолчанию повторно задается.
resizeTimeout	string (duration)	Время ожидания выделения узлов в пул или удаление вычислительных узлов из пула. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос).
targetDedicatedNodes	integer (int32)	Требуемое количество выделенных вычислительных узлов в пуле.
targetLowPriorityNodes	integer (int32)	Требуемое количество точечных и низкоприоритетных вычислительных узлов в пуле.

Ответы

Имя	Тип	Описание
202 Accepted		Запрос был принят для обработки, но обработка еще не завершена. Заголовки DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Непредвиденное сообщение об ошибке.

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

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://batch.core.windows.net//.default

Примеры

Pool resize

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

HTTP

POST {endpoint}/pools/resizePool/resize?api-version=2025-06-01



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

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

Код состояния:

202

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchNodeDeallocationOption	BatchNodeDeallocationOption enums
BatchPoolResizeOptions	Параметры для изменения размера пула пакетной службы Azure.

BatchError

Объект

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

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	BatchErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

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

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

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

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке.
value	string	Текст сообщения.

BatchNodeDeallocationOption

Перечисление

BatchNodeDeallocationOption enums

Значение	Описание
requeue	Завершите выполнение процессов задач и повторно ввели задачи. Задачи будут выполняться снова при доступности вычислительного узла. Удалите вычислительные узлы сразу после завершения задач.
terminate	Завершение выполнения задач. Задачи будут завершены с помощью failureInfo, указывающего, что они были завершены и не будут выполняться снова. Удалите вычислительные узлы сразу после завершения задач.
taskcompletion	Разрешить выполнение задач в настоящее время. Запланируйте новые задачи во время ожидания. Удалите вычислительные узлы после завершения всех задач.
retaineddata	Мы рекомендуем отправлять данные задачи в службу хранилища Azure в задаче и использовать TaskCompletion их вместо этого. Разрешите выполнение задач, а затем дождитесь истечения срока хранения всех данных задачи. Запланируйте новые задачи во время ожидания. Удалите вычислительные узлы, когда истек срок хранения всех задач.

BatchPoolResizeOptions

Объект

Параметры для изменения размера пула пакетной службы Azure.

Имя	Тип	Описание
nodeDeallocationOption	BatchNodeDeallocationOption	Определяет, что делать с вычислительным узлом и его выполняемыми задачами, если размер пула уменьшается. Значение по умолчанию повторно задается.
resizeTimeout	string (duration)	Время ожидания выделения узлов в пул или удаление вычислительных узлов из пула. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос).
targetDedicatedNodes	integer (int32)	Требуемое количество выделенных вычислительных узлов в пуле.
targetLowPriorityNodes	integer (int32)	Требуемое количество точечных и низкоприоритетных вычислительных узлов в пуле.