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

Pool - Evaluate Auto Scale

Service:

Batch Service

API Version:

2023-11-01.18.0

获取计算池上的自动缩放公式的结果。
此 API 主要用于验证自动缩放公式，因为它只需返回结果，而不将公式应用于池。 池必须启用自动缩放才能计算公式。

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

With optional parameters:

POST {batchUrl}/pools/{poolId}/evaluateautoscale?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，请显式设置它。

请求正文

Media Types: "application/json; odata=minimalmetadata"

名称	必需	类型	说明
autoScaleFormula	True	string	池中所需计算节点数的公式。 公式经过验证并计算其结果，但不应用于池。 若要将公式应用于池，请在池上启用自动缩放。 有关指定此公式的详细信息，请参阅自动缩放Azure Batch池中的计算节点 (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) 。

响应

名称	类型	说明
200 OK	AutoScaleRun	包含自动缩放评估结果的响应。 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 evaluate autoscale

Sample Request

HTTP

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



{
  "autoScaleFormula": "$TargetDedicated=1"
}

Sample Response

Status code:

200

{
  "timestamp": "2016-11-22T19:39:28.5246331Z",
  "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}

定义

名称	说明
AutoScaleRun	池自动缩放公式执行的结果和错误。
AutoScaleRunError	执行或计算池自动缩放公式时发生的错误。
BatchError	从Azure Batch服务收到的错误响应。
BatchErrorDetail	Azure Batch错误响应中包含的其他信息项。
ErrorMessage	Azure Batch错误响应中收到的错误消息。
NameValuePair	表示一个名称-值对。
PoolEvaluateAutoScaleParameter	用于评估池上的自动缩放公式的选项。

AutoScaleRun

池自动缩放公式执行的结果和错误。

名称	类型	说明
error	AutoScaleRunError	如果计算失败，则计算池上的自动缩放公式时遇到错误的详细信息。
results	string	自动缩放公式计算中使用的所有变量的最终值。 每个变量值以 $variable=value 的形式返回，变量用分号分隔。
timestamp	string	上次计算自动缩放公式的时间。

AutoScaleRunError

执行或计算池自动缩放公式时发生的错误。

名称	类型	说明
code	string	自动缩放错误的标识符。 代码是固定的，旨在以编程方式使用。
message	string	描述自动缩放错误的消息，该错误适用于在用户界面中显示。
values	NameValuePair[]	与自动缩放错误相关的其他错误详细信息的列表。

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

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

NameValuePair

表示一个名称-值对。

名称	类型	说明
name	string	名称/值对中的名称。
value	string	名称/值对中的值。

PoolEvaluateAutoScaleParameter

用于评估池上的自动缩放公式的选项。

名称	类型	说明
autoScaleFormula	string	池中所需计算节点数的公式。 公式经过验证并计算其结果，但不应用于池。 若要将公式应用于池，请在池上启用自动缩放。 有关指定此公式的详细信息，请参阅自动缩放Azure Batch池中的计算节点 (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) 。