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

Pool - Enable Auto Scale

Service:

Batch Service

API Version:

2023-11-01.18.0

为池启用自动缩放。
如果在池上执行重设大小操作，则无法对池启用自动缩放。 如果当前禁用了池的自动缩放，则必须在请求中指定有效的自动缩放公式。 如果已启用池的自动缩放，则可以指定新的自动缩放公式和/或新的评估间隔。 不能每 30 秒多次调用同一池的此 API。

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

With optional parameters:

POST {batchUrl}/pools/{poolId}/enableautoscale?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"

名称	类型	说明
autoScaleEvaluationInterval	string	根据自动缩放公式自动调整池大小的时间间隔。 默认值为 15 分钟。 最小值和最大值分别为 5 分钟和 168 小时。 如果指定的值小于 5 分钟或大于 168 小时，Batch 服务将拒绝请求并显示无效的属性值错误;如果直接调用 REST API，则 HTTP 状态代码为 400 (错误请求) 。 如果指定新间隔，则会停止现有的自动缩放评估计划，并启动新的自动缩放评估计划，其开始时间是发出此请求的时间。
autoScaleFormula	string	池中所需计算节点数的公式。 在将公式应用到池之前，将检查公式的有效性。 如果公式无效，Batch 服务会拒绝包含详细错误信息的请求。 有关指定此公式的详细信息，请参阅自动缩放Azure Batch池中的计算节点 (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) 。

响应

名称	类型	说明
200 OK		对 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 enable autoscale

Sample Request

HTTP

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



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Sample Response

Status code:

200

定义

名称	说明
BatchError	从Azure Batch服务收到的错误响应。
BatchErrorDetail	Azure Batch错误响应中包含的其他信息项。
ErrorMessage	Azure Batch错误响应中收到的错误消息。
PoolEnableAutoScaleParameter	用于在池上启用自动缩放的选项。

BatchError

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

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

BatchErrorDetail

Azure Batch错误响应中包含的其他信息项。

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

ErrorMessage

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

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

PoolEnableAutoScaleParameter

用于在池上启用自动缩放的选项。

名称	类型	说明
autoScaleEvaluationInterval	string	根据自动缩放公式自动调整池大小的时间间隔。 默认值为 15 分钟。 最小值和最大值分别为 5 分钟和 168 小时。 如果指定的值小于 5 分钟或大于 168 小时，Batch 服务将拒绝请求并显示无效的属性值错误;如果直接调用 REST API，则 HTTP 状态代码为 400 (错误请求) 。 如果指定新间隔，则会停止现有的自动缩放评估计划，并启动新的自动缩放评估计划，其开始时间是发出此请求的时间。
autoScaleFormula	string	池中所需计算节点数的公式。 在将公式应用到池之前，将检查公式的有效性。 如果公式无效，Batch 服务会拒绝包含详细错误信息的请求。 有关指定此公式的详细信息，请参阅自动缩放Azure Batch池中的计算节点 (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) 。