RebootInstances - 大量重啟執行個體 - Elastic Compute Service

本介面用於重啟一台或多台ECS執行個體，支援您通過參數來選擇是否強制重啟和設定不同的大量操作模式。

介面說明

該介面為非同步介面，執行個體的重啟不是立即完成的，成功調用後，執行個體會先進入啟動中（Starting）狀態，你可以調用 DescribeInstanceStatus 查看執行個體狀態，當返回的狀態為Running時代表重啟成功。

使用須知

被安全鎖定的執行個體不能通過調用該介面重啟。更多資訊，請參見資源安全鎖定對調用 API 的影響。
ECS 執行個體的狀態必須為運行中（Running）。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:RebootInstances

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
DryRun	boolean	否	是否只預檢此次請求。取值範圍： true：發送檢查請求，不會重啟執行個體。檢查項包括是否填寫了必需參數、請求格式、執行個體狀態。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回`DRYRUN.SUCCESS`。說明如果參數`BatchOptimization`被設定為`SuccessFirst`，對應的`DryRun=true`的預檢結果只會返回`DRYRUN.SUCCESS`。 false：發送正常請求，通過檢查後直接重啟執行個體。預設值：false。	false
RegionId	string	是	執行個體所在的地區。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
ForceReboot	boolean	否	是否強制重啟。取值範圍： true：強制重啟。相當於典型的斷電操作，所有未寫入存放裝置的快取資料會丟失。 false：正常重啟。預設值：false。	false
BatchOptimization	string	否	設定大量操作模式。取值範圍： AllTogether：該模式下，如果執行個體全部重啟成功，則返回成功資訊；如果任意一個執行個體校正不通過，則所有執行個體重啟失敗，並返回失敗資訊。 SuccessFirst：該模式下，分別重啟每個執行個體，返回結果包含每個執行個體的操作結果資訊。預設值：AllTogether。	AllTogether
InstanceId	array	是	執行個體 ID 數組。數組長度：1~100。	i-bp67acfmxazb4p****
	string	否	執行個體 ID。	i-bp67acfmxazb4p****

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
InstanceResponses	object
InstanceResponse	array<object>	由 InstanceResponse 組成的數組格式，返回每個執行個體操作的前後狀態及操作結果。
	object
Code	string	執行個體操作結果錯誤碼。傳回值為 200 表示操作成功。更多資訊，請參見下文錯誤碼列表。	200
Message	string	執行個體操作返回錯誤資訊。傳回值為 Success 表示操作成功。更多資訊，請參見下文錯誤碼列表。	success
InstanceId	string	執行個體 ID。	i-bp1g6zv0ce8oghu7****
CurrentStatus	string	執行個體目前狀態。	Stopping
PreviousStatus	string	執行個體操作前狀態。	Running

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "InstanceResponses": {
    "InstanceResponse": [
      {
        "Code": "200",
        "Message": "success",
        "InstanceId": "i-bp1g6zv0ce8oghu7****",
        "CurrentStatus": "Stopping",
        "PreviousStatus": "Running"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be added ECS tag
400	InvalidParameter.KMSKeyId.KMSUnauthorized	ECS service account have no right to access your KMS.	ECS 服務無權訪問您的 KMS
400	DRYRUN.SUCCESS	This request is a dryrun request with successful result.	您設定了預檢此次請求，並且檢查通過。
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidInstanceId.NotFound	InstanceId should not be null.
403	InvalidParameter.TooManyInstanceIds	Instance ids cannot be more than 100.	InstanceIds列表長度超過100。
403	Abs.InvalidInstanceIds.MalFormed	The specified instanceIds is not valid.	指定的InstanceId參數不合法
403	InstanceLockedForSecurity	%s
403	InstanceExpiredOrInArrears	%s
403	IncorrectInstanceStatus	%s	當前執行個體的狀態不支援此操作。
403	InvalidInstance.NotFoundSystemDisk	%s	指定的執行個體ID未掛載系統硬碟，無法啟動，具體資訊請參見錯誤資訊%s預留位置的實際返回結果。請先調用AttachDisk為指定的執行個體掛載系統硬碟。
403	InsufficientBalance	Your account does not have enough balance.
403	InstanceNotReady	The specified instance is not ready for use.
404	InvalidInstanceId.NotFound	%s
404	InvalidInstanceIds.NotFound	The specified InstanceIds does not exist.	指定的 InstanceId 不存在。請檢查 InstanceId 參數值是否正確。您可以調用 DescribeInstances 查詢指定執行個體的狀態。
503	LimitedOperation.ServiceUnavailable	The service is currently unavailable. Please try again later.	當前服務不可用。請稍後重試。
409	InvalidOperation.Conflict	Request was denied due to conflict with a previous request, please try again later.	請求操作的資源與之前的請求衝突

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。