Pool - Remove Nodes

Service:

Batch Service

API Version:

2023-11-01.18.0

指定したプールからコンピューティング ノードを削除します。
この操作は、プールの割り当て状態が安定している場合にのみ実行できます。 この操作を実行すると、割り当ての状態が安定した状態からサイズ変更に変わります。 各要求では、最大 100 個のノードを削除できます。

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

With optional parameters:

POST {batchUrl}/pools/{poolId}/removenodes?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	呼び出し元によって生成された要求 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"

名前	必須	型	説明
nodeList	True	string[]	指定したプールから削除するコンピューティング ノードの ID を含むリスト。 要求ごとに最大 100 個のノードを削除できます。
nodeDeallocationOption		ComputeNodeDeallocationOption	割り当て解除が選択された後に、コンピューティング ノードとその実行中のタスクの処理方法を決定します。 既定値は requeue です。
resizeTimeout		string	プールへのコンピューティング ノードの削除のタイムアウト。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

応答

名前	型	説明
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 remove nodes

Sample Request

HTTP

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



{
  "nodeList": [
    "tvm-1695681911_1-20161122t224741z",
    "tvm-1695681911_2-20161122t224741z"
  ]
}

Sample Response

Status code:

202

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batchエラー応答に含まれる追加情報の項目。
ComputeNodeDeallocationOption	割り当て解除が選択された後に、コンピューティング ノードとその実行中のタスクの処理方法を決定します。
ErrorMessage	Azure Batchエラー応答で受信したエラー メッセージ。
NodeRemoveParameter	プールからコンピューティング ノードを削除するためのオプション。

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	メッセージのテキストです。

NodeRemoveParameter

プールからコンピューティング ノードを削除するためのオプション。

名前	型	説明
nodeDeallocationOption	ComputeNodeDeallocationOption	割り当て解除が選択された後に、コンピューティング ノードとその実行中のタスクの処理方法を決定します。 既定値は requeue です。
nodeList	string[]	指定したプールから削除するコンピューティング ノードの ID を含むリスト。 要求ごとに最大 100 個のノードを削除できます。
resizeTimeout	string	プールへのコンピューティング ノードの削除のタイムアウト。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。