Pool - Enable Auto Scale

  • リファレンス
サービス:
Batch Service
API バージョン:
2024-07-01.20.0

プールの自動スケーリングを有効にします。
プールでサイズ変更操作が進行中の場合、プールで自動スケーリングを有効にすることはできません。 プールの自動スケーリングが現在無効になっている場合は、要求の一部として有効な自動スケール式を指定する必要があります。 プールの自動スケーリングが既に有効になっている場合は、新しい自動スケール式または新しい評価間隔を指定できます。 同じプールに対してこの API を 30 秒ごとに複数回呼び出すことはできません。

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2024-07-01.20.0
省略可能なパラメーターを含む: 
POST {batchUrl}/pools/{poolId}/enableautoscale?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 を直接呼び出す場合は、明示的に設定します。
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/documentation/articles/batch-automatic-scaling)」を参照してください。

応答

名前 型 説明
200 OK

Batch サービスへの要求が成功しました。

ヘッダー

  • 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 enable autoscale

要求のサンプル

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



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

応答のサンプル

状態コード:
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/documentation/articles/batch-automatic-scaling)」を参照してください。