Pool - Resize

Ссылка

Service:: Batch Service

API Version:: 2022-01-01.15.0

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

POST {batchUrl}/pools/{poolId}/resize?api-version=2022-01-01.15.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/resize?timeout={timeout}&api-version=2022-01-01.15.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	Type	Description
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"

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

Ответы

Name	Type	Description
202 Accepted		Запрос к пакетной службе выполнен успешно. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Ошибка пакетной службы.

Name

Type

Description

202 Accepted

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

Headers

client-request-id: string
request-id: string
ETag: string
Last-Modified: string
DataServiceId: string

Other Status Codes

BatchError

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

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

azure_auth

Flow 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 resize

Sample Request

HTTP

POST account.region.batch.azure.com/pools/resizePool/resize?api-version=2022-01-01.15.0



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

Sample Response

Status code:: 202

Определения

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

BatchError

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

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

BatchErrorDetail

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

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

ComputeNodeDeallocationOption

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

Name	Type	Description
requeue	string	Завершите выполнение процессов задач и повторно запустите задачи. Задачи будут выполняться снова, когда вычислительный узел доступен. Удалите вычислительные узлы сразу после завершения задач.
retaineddata	string	Разрешите выполнение задач, а затем дождитесь истечения срока хранения всех данных задачи. Не запланируйте новые задачи во время ожидания. Удалите вычислительные узлы при истечении всех периодов хранения задач.
taskcompletion	string	Разрешить выполнение задач в настоящее время. Не запланируйте новые задачи во время ожидания. Удалите вычислительные узлы после завершения всех задач.
terminate	string	Завершение выполнения задач. Задачи будут завершены с помощью failureInfo, указывая, что они были завершены и не будут выполняться снова. Удалите вычислительные узлы сразу после завершения задач.

ErrorMessage

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

Name	Type	Description
lang	string	Код языка сообщения об ошибке
value	string	Текст сообщения.

PoolResizeParameter

Параметры изменения размера пула.

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