本接口用于重啟一臺ECS實例。
接口說明
該接口為異步接口，實例的重啟不是立即完成的，成功調用后，實例會先進入啟動中（Starting）狀態，你可以調用 DescribeInstanceStatus 查看實例狀態，當返回的狀態為Running時代表重啟成功。
使用須知
- 被安全鎖定的實例不能通過調用該接口重啟。更多信息，請參見資源安全鎖定對調用 API 的影響。
- 您只能重啟狀態為運行中（
Running）的 ECS 實例。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecs:RebootInstance | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 指定實例的 ID。 | i-bp67acfmxazb4ph**** |
| ForceStop | boolean | 否 | 重啟 ECS 實例前，是否強制關機。取值范圍：
默認值：false。 | false |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值范圍：
默認值：false。 | false |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | 該資源目前的狀態不支持此操作。 |
| 403 | InstanceLockedForSecurity | The specified operation is denied as your instance is locked for security reasons. | 實例被安全鎖定。 |
| 403 | DiskError | IncorrectDiskStatus. | 指定的磁盤狀態不合法。 |
| 403 | InstanceExpiredOrInArrears | The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). | 實例已過期或者欠費，請您續費或者結清后再進行操作。 |
| 403 | IncorrectInstanceStatus | %s | 當前實例的狀態不支持此操作。 |
| 403 | InvalidParameter.KMSKeyId.CMKUnauthorized | %s | - |
| 403 | InvalidParameter.KMSKeyId.CMKNotEnabled | %s | - |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | %s | - |
| 404 | InvalidParameter.KMSKeyId.NotFound | %s | - |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的InstanceId不存在。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤，請重試。 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內部錯誤，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-07-17 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |