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 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
nodeId	path	True	string	您要重新啟動之計算節點的識別碼。
poolId	path	True	string	包含計算節點的集區識別碼。
api-version	query	True	string	用戶端 API 版本。
timeout	query		integer int32	伺服器可以花費在數秒內處理要求的時間上限。 預設值為 30 秒。

要求標頭

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

名稱	必要	類型	Description
client-request-id		string uuid	呼叫端產生的要求身分識別，格式為不含大括弧的 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"

名稱	類型	Description
nodeRebootOption	ComputeNodeRebootOption	重新啟動計算節點的時機，以及目前執行中工作的動作。 預設值為 requeue。

回應

名稱	類型	Description
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

名稱	Description
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

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
ComputeNodeRebootOption	重新啟動計算節點的時機，以及目前執行中工作的動作。
ErrorMessage	在 Azure Batch 錯誤回應中收到的錯誤訊息。
NodeRebootParameter	重新啟動計算節點的選項。

BatchError

從 Azure Batch 服務收到的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。
message	ErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應中包含的其他資訊。

ComputeNodeRebootOption

重新啟動計算節點的時機，以及目前執行中工作的動作。

名稱	類型	Description
requeue	string	終止執行中的工作進程，並重新排入工作佇列。 當計算節點可用時，工作會再次執行。 一旦工作終止，請重新啟動計算節點。
retaineddata	string	允許目前執行的工作完成，然後等候所有任務數據保留期間到期。 在等候時排程沒有新的工作。 當所有任務保留期間都過期時，請重新啟動計算節點。
taskcompletion	string	允許目前正在執行的工作完成。 在等候時排程沒有新的工作。 當所有工作完成時，請重新啟動計算節點。
terminate	string	終止執行中的工作。 [工作] 將會完成，但 failureInfo 指出它們已終止，且不會再次執行。 一旦工作終止，請重新啟動計算節點。

ErrorMessage

在 Azure Batch 錯誤回應中收到的錯誤訊息。

名稱	類型	Description
lang	string	錯誤訊息的語言代碼
value	string	訊息的文字。

NodeRebootParameter

重新啟動計算節點的選項。

名稱	類型	Description
nodeRebootOption	ComputeNodeRebootOption	重新啟動計算節點的時機，以及目前執行中工作的動作。 預設值為 requeue。