Nodes - Reboot Node
指定したコンピューティング ノードを再起動します。
コンピューティング ノードは、アイドル状態または実行中の状態の場合にのみ再起動できます。
POST {endpoint}/pools/{poolId}/nodes/{nodeId}/reboot?api-version=2025-06-01
POST {endpoint}/pools/{poolId}/nodes/{nodeId}/reboot?api-version=2025-06-01&timeOut={timeOut}
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Batch アカウント エンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。 |
|
node
|
path | True |
string |
再起動するコンピューティング ノードの ID。 |
|
pool
|
path | True |
string |
コンピューティング ノードを含むプールの ID。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
|
time
|
query |
integer (int32) |
サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が30より大きい場合は、デフォルトが使われます。」 |
要求ヘッダー
Media Types: "application/json; odata=minimalmetadata"
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| client-request-id |
string |
呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。 |
|
| return-client-request-id |
boolean |
サーバーが応答で client-request-id を返す必要があるかどうか。 |
|
| ocp-date |
string (date-time-rfc7231) |
要求が発行された時刻。 通常、クライアント ライブラリはこれを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。 |
要求本文
Media Types: "application/json; odata=minimalmetadata"
| 名前 | 型 | 説明 |
|---|---|---|
| nodeRebootOption |
コンピューティング ノードを再起動するタイミングと、現在実行中のタスクの操作。 既定値は requeue です。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 202 Accepted |
要求は処理のために受け入れ済みですが、処理はまだ完了していません。 ヘッダー
|
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
OAuth2Auth
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ
| 名前 | 説明 |
|---|---|
| https://batch.core.windows.net//.default |
例
Node reboot
要求のサンプル
POST {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/reboot?api-version=2025-06-01
応答のサンプル
定義
| 名前 | 説明 |
|---|---|
|
Batch |
Azure Batch サービスから受信したエラー応答。 |
|
Batch |
Azure Batch エラー応答に含まれる追加情報の項目。 |
|
Batch |
Azure Batch エラー応答で受信したエラー メッセージ。 |
|
Batch |
BatchNodeRebootKindの列挙式 |
|
Batch |
Azure Batch コンピューティング ノードを再起動するためのパラメーター。 |
BatchError
Azure Batch サービスから受信したエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
| message |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
|
| values |
エラーに関する追加の詳細を含むキーと値のペアのコレクション。 |
BatchErrorDetail
Azure Batch エラー応答に含まれる追加情報の項目。
| 名前 | 型 | 説明 |
|---|---|---|
| key |
string |
Value プロパティの意味を指定する識別子。 |
| value |
string |
エラー応答に含まれる追加情報。 |
BatchErrorMessage
Azure Batch エラー応答で受信したエラー メッセージ。
| 名前 | 型 | 説明 |
|---|---|---|
| lang |
string |
エラーメッセージの言語コード。 |
| value |
string |
メッセージのテキスト。 |
BatchNodeRebootKind
BatchNodeRebootKindの列挙式
| 値 | 説明 |
|---|---|
| requeue |
実行中のタスク プロセスを終了し、タスクを再キューします。 コンピューティング ノードが使用可能になると、タスクが再度実行されます。 タスクが終了したらすぐにコンピューティング ノードを再起動します。 |
| terminate |
実行中のタスクを終了します。 タスクは、終了されたことを示す failureInfo で完了し、もう一度実行されません。 タスクが終了したらすぐにコンピューティング ノードを再起動します。 |
| taskcompletion |
現在実行中のタスクの完了を許可します。 待機中に新しいタスクをスケジュールしません。 すべてのタスクが完了したら、コンピューティング ノードを再起動します。 |
| retaineddata |
非推奨になりましたが、タスクの Azure Storage にタスク データをアップロードし、代わりに |
BatchNodeRebootOptions
Azure Batch コンピューティング ノードを再起動するためのパラメーター。
| 名前 | 型 | 説明 |
|---|---|---|
| nodeRebootOption |
コンピューティング ノードを再起動するタイミングと、現在実行中のタスクの操作。 既定値は requeue です。 |