你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Pool - Remove Nodes
从指定的池中删除计算节点。
仅当池的分配状态稳定时,才能运行此操作。 此操作运行时,分配状态将从“稳定”更改为“调整大小”。 每个请求最多可以删除 100 个节点。
POST {batchUrl}/pools/{poolId}/removenodes?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/removenodes?timeout={timeout}&api-version=2023-11-01.18.0
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
batch
|
path | True |
string |
所有Azure Batch服务请求的基 URL。 |
pool
|
path | True |
string |
要从中删除计算节点的池的 ID。 |
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[] |
包含要从指定池中删除的计算节点的 ID 的列表。 |
nodeDeallocationOption |
确定计算节点及其正在运行的任务在选择解除分配后 () 执行的操作。 |
||
resizeTimeout |
string |
将计算节点删除到池的超时。 |
响应
名称 | 类型 | 说明 |
---|---|---|
202 Accepted |
对 Batch 服务的请求已成功。 标头
|
|
Other Status Codes |
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
示例请求
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"
]
}
示例响应
定义
名称 | 说明 |
---|---|
Batch |
从Azure Batch服务收到的错误响应。 |
Batch |
Azure Batch错误响应中包含的其他信息项。 |
Compute |
确定计算节点及其正在运行的任务在选择解除分配后 () 执行的操作。 |
Error |
Azure Batch错误响应中收到的错误消息。 |
Node |
用于从池中删除计算节点的选项。 |
BatchError
从Azure Batch服务收到的错误响应。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
message |
描述错误的消息,该消息适用于在用户界面中显示。 |
|
values |
包含有关错误的其他详细信息的键值对的集合。 |
BatchErrorDetail
Azure Batch错误响应中包含的其他信息项。
名称 | 类型 | 说明 |
---|---|---|
key |
string |
指定 Value 属性含义的标识符。 |
value |
string |
错误响应附带的其他信息。 |
ComputeNodeDeallocationOption
确定计算节点及其正在运行的任务在选择解除分配后 () 执行的操作。
名称 | 类型 | 说明 |
---|---|---|
requeue |
string |
终止正在运行的任务进程并重新排队任务。 当计算节点可用时,任务将再次运行。 任务终止后立即删除计算节点。 |
retaineddata |
string |
允许当前运行的任务完成,然后等待所有任务数据保留期到期。 在等待时计划不执行任何新任务。 当所有任务保留期都过期时删除计算节点。 |
taskcompletion |
string |
允许当前运行的任务完成。 在等待时计划不执行任何新任务。 完成所有任务后,删除计算节点。 |
terminate |
string |
终止正在运行的任务。 任务将完成,并显示 failureInfo,指示它们已终止,并且不会再次运行。 任务终止后立即删除计算节点。 |
ErrorMessage
Azure Batch错误响应中收到的错误消息。
名称 | 类型 | 说明 |
---|---|---|
lang |
string |
错误消息的语言代码 |
value |
string |
消息的文本。 |
NodeRemoveParameter
用于从池中删除计算节点的选项。
名称 | 类型 | 说明 |
---|---|---|
nodeDeallocationOption |
确定计算节点及其正在运行的任务在选择解除分配后 () 执行的操作。 |
|
nodeList |
string[] |
包含要从指定池中删除的计算节点的 ID 的列表。 |
resizeTimeout |
string |
将计算节点删除到池的超时。 |