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

Pool - Resize

Service:

Batch Service

API Version:

2023-11-01.18.0

更改分配给池的计算节点数。
只能在池的分配状态稳定时调整其大小。 如果池已调整大小，请求将失败，状态代码为 409。 调整池大小时，池的分配状态将从稳定更改为调整大小。 无法调整为自动缩放配置的池的大小。 如果尝试执行此操作，Batch 服务将返回错误 409。 如果向下调整池的大小，Batch 服务将选择要删除的计算节点。 若要删除特定的计算节点，请改用池删除计算节点 API。

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

With optional parameters:

POST {batchUrl}/pools/{poolId}/resize?timeout={timeout}&api-version=2023-11-01.18.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 秒。

请求头

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"

名称	类型	说明
nodeDeallocationOption	ComputeNodeDeallocationOption	确定池大小减小时，计算节点及其正在运行的任务 () 做什么。 默认值为 requeue。
resizeTimeout	string	将节点分配到池或从池中删除计算节点的超时。 默认值为 15 分钟。 最小值为 5 分钟。 如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400 (错误请求) 。
targetDedicatedNodes	integer	池中所需的专用计算节点数。
targetLowPriorityNodes	integer	池中所需的现成/低优先级计算节点数。

响应

名称	类型	说明
202 Accepted		对 Batch 服务的请求已成功。 Headers 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 身份验证代码流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

Authorization

Type: apiKey
In: header

示例

Pool resize

Sample Request

HTTP

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



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

Sample Response

Status code:

202

定义

名称	说明
BatchError	从Azure Batch服务收到的错误响应。
BatchErrorDetail	Azure Batch错误响应中包含的其他信息项。
ComputeNodeDeallocationOption	确定计算节点及其正在运行的任务 () 在选择解除分配后如何处理该节点。
ErrorMessage	Azure Batch错误响应中收到的错误消息。
PoolResizeParameter	用于更改池大小的选项。

BatchError

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

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

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	消息的文本。

PoolResizeParameter

用于更改池大小的选项。

名称	类型	说明
nodeDeallocationOption	ComputeNodeDeallocationOption	确定池大小减小时，计算节点及其正在运行的任务 () 做什么。 默认值为 requeue。
resizeTimeout	string	将节点分配到池或从池中删除计算节点的超时。 默认值为 15 分钟。 最小值为 5 分钟。 如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400 (错误请求) 。
targetDedicatedNodes	integer	池中所需的专用计算节点数。
targetLowPriorityNodes	integer	池中所需的现成/低优先级计算节点数。