你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Pool - Remove Nodes

服务:

Batch Service

API 版本:

2024-07-01.20.0

从指定的池中删除计算节点。
此作只能在池的分配状态稳定时运行。 此作运行时，分配状态将从稳定更改为调整大小。 每个请求最多可以删除 100 个节点。

POST {batchUrl}/pools/{poolId}/removenodes?api-version=2024-07-01.20.0

具有可选参数:

POST {batchUrl}/pools/{poolId}/removenodes?timeout={timeout}&api-version=2024-07-01.20.0

URI 参数

名称	在	必需	类型	说明
batchUrl	path	True	string	所有 Azure Batch 服务请求的基本 URL。
poolId	path	True	string	要从中删除计算节点的池的 ID。
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"

名称	必需	类型	说明
nodeList	True	string[]	包含要从指定池中删除的计算节点 ID 的列表。 每个请求最多可以删除 100 个节点。
nodeDeallocationOption		ComputeNodeDeallocationOption	确定在为解除分配选择计算节点及其正在运行的任务后，如何处理计算节点及其正在运行的任务。 默认值为重新排队。
resizeTimeout		string (duration)	将计算节点删除到池的超时。 默认值为“15 分钟”。 最小值为 5 分钟。 如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。

响应

名称	类型	说明
202 Accepted		对 Batch 服务的请求成功。 标头 client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch 服务中的错误。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

Authorization

类型: apiKey
在: header

示例

Pool remove nodes

示例请求

HTTP

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



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

示例响应

状态代码:

202

定义

名称	说明
BatchError	从 Azure Batch 服务收到的错误响应。
BatchErrorDetail	Azure Batch 错误响应中包含的附加信息项。
ComputeNodeDeallocationOption	确定在为解除分配选择计算节点及其正在运行的任务后，如何处理计算节点及其正在运行的任务。
ErrorMessage	Azure Batch 错误响应中收到的错误消息。
NodeRemoveParameter	用于从池中删除计算节点的选项。

BatchError

Object

从 Azure Batch 服务收到的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
message	ErrorMessage	描述错误的消息，旨在适合在用户界面中显示。
values	BatchErrorDetail[]	包含有关错误的更多详细信息的键值对的集合。

BatchErrorDetail

Object

Azure Batch 错误响应中包含的附加信息项。

名称	类型	说明
key	string	指定 Value 属性含义的标识符。
value	string	错误响应附带的其他信息。

ComputeNodeDeallocationOption

枚举

确定在为解除分配选择计算节点及其正在运行的任务后，如何处理计算节点及其正在运行的任务。

值	说明
requeue	终止正在运行的任务进程并重新排队任务。 当计算节点可用时，任务将再次运行。 在任务终止后立即删除计算节点。
retaineddata	允许当前运行的任务完成，然后等待所有任务数据保留期到期。 等待时不安排新任务。 删除所有任务保留期已过期的计算节点。
taskcompletion	允许当前运行的任务完成。 等待时不安排新任务。 完成所有任务后，删除计算节点。
terminate	终止正在运行的任务。 任务将通过 failureInfo 完成，指示它们已终止，并且不会再次运行。 在任务终止后立即删除计算节点。

ErrorMessage

Object

Azure Batch 错误响应中收到的错误消息。

名称	类型	说明
lang	string	错误消息的语言代码
value	string	消息的文本。

NodeRemoveParameter

Object

用于从池中删除计算节点的选项。

名称	类型	说明
nodeDeallocationOption	ComputeNodeDeallocationOption	确定在为解除分配选择计算节点及其正在运行的任务后，如何处理计算节点及其正在运行的任务。 默认值为重新排队。
nodeList	string[]	包含要从指定池中删除的计算节点 ID 的列表。 每个请求最多可以删除 100 个节点。
resizeTimeout	string (duration)	将计算节点删除到池的超时。 默认值为“15 分钟”。 最小值为 5 分钟。 如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。