Compute Node - Reboot

リファレンス

Service:: Batch Service

API Version:: 2023-11-01.18.0

指定したコンピューティングノードを再起動します。
コンピューティングノードは、アイドル状態または実行中の状態の場合にのみ再起動できます。

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/reboot?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/reboot?timeout={timeout}&api-version=2023-11-01.18.0

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべてのAzure Batchサービス要求のベース URL。
nodeId	path	True	string	再起動するコンピューティングノードの ID。
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 を直接呼び出す場合は、明示的に設定します。

要求本文

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

名前	型	説明
nodeRebootOption	ComputeNodeRebootOption	コンピューティングノードを再起動するタイミングと、現在実行中のタスクに対する対処方法。既定値は requeue です。

応答

名前	型	説明
202 Accepted		Batch サービスへの要求が成功しました。 Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

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

例

Node reboot

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/reboot?api-version=2023-11-01.18.0



{
  "nodeRebootOption": "terminate"
}

Sample Response

Status code:: 202

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batchエラー応答に含まれる追加情報の項目。
ComputeNodeRebootOption	コンピューティングノードを再起動するタイミングと、現在実行中のタスクに対する対処方法。
ErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
NodeRebootParameter	コンピューティングノードを再起動するためのオプション。

BatchError

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
message	ErrorMessage	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Azure Batchエラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。