Pool - Evaluate Auto Scale

サービス:

Batch Service

API バージョン:

2024-07-01.20.0

プールで自動スケーリング式を評価した結果を取得します。
この API は、プールに数式を適用せずに結果を返すだけなので、主に自動スケール式を検証するための API です。 数式を評価するには、プールで自動スケーリングが有効になっている必要があります。

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

省略可能なパラメーターを含む:

POST {batchUrl}/pools/{poolId}/evaluateautoscale?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	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない 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://learn.microsoft.com/azure/batch/batch-automatic-scaling) を参照してください。

応答

名前	型	説明
200 OK	AutoScaleRun	自動スケール評価の結果を含む応答。 ヘッダー 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
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

Authorization

型: apiKey
/: header

例

Pool evaluate autoscale

要求のサンプル

HTTP

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



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

応答のサンプル

状態コード:

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://learn.microsoft.com/azure/batch/batch-automatic-scaling) を参照してください。