Pool - Remove Nodes

Service:

Batch Service

API Version:

2023-11-01.18.0

Удаляет вычислительные узлы из указанного пула.
Эта операция может выполняться только в том случае, если состояние выделения пула стабильное. При выполнении этой операции состояние выделения изменяется с устойчивого на изменение размера. Каждый запрос может удалить до 100 узлов.

POST {batchUrl}/pools/{poolId}/removenodes?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/removenodes?timeout={timeout}&api-version=2023-11-01.18.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
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"

Имя	Обязательно	Тип	Описание
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"

Имя	Обязательно	Тип	Описание
nodeList	True	string[]	Список, содержащий идентификаторы вычислительных узлов, удаляемых из указанного пула. Для каждого запроса может быть удалено не более 100 узлов.
nodeDeallocationOption		ComputeNodeDeallocationOption	Определяет, что делать с вычислительным узлом и выполняемыми на нем задачами после выбора для освобождения. По умолчанию используется значение requeue.
resizeTimeout		string	Время ожидания для удаления вычислительных узлов в пул. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).

Ответы

Имя	Тип	Описание
202 Accepted		Запрос к пакетной службе выполнен успешно. Headers 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

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

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Pool remove nodes

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/removenodes?api-version=2023-11-01.18.0



{
  "nodeList": [
    "tvm-1695681911_1-20161122t224741z",
    "tvm-1695681911_2-20161122t224741z"
  ]
}

Sample Response

Status code:

202

Определения

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

BatchError

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

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

BatchErrorDetail

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

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

ComputeNodeDeallocationOption

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

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

ErrorMessage

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

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

NodeRemoveParameter

Параметры удаления вычислительных узлов из пула.

Имя	Тип	Описание
nodeDeallocationOption	ComputeNodeDeallocationOption	Определяет, что делать с вычислительным узлом и выполняемыми на нем задачами после выбора для освобождения. По умолчанию используется значение requeue.
nodeList	string[]	Список, содержащий идентификаторы вычислительных узлов, удаляемых из указанного пула. Для каждого запроса может быть удалено не более 100 узлов.
resizeTimeout	string	Время ожидания для удаления вычислительных узлов в пул. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).