本接口用于重啟一臺(tái)或多臺(tái)ECS實(shí)例，支持您通過參數(shù)來選擇是否強(qiáng)制重啟和設(shè)置不同的批量操作模式。
接口說明
該接口為異步接口，實(shí)例的重啟不是立即完成的，成功調(diào)用后，實(shí)例會(huì)先進(jìn)入啟動(dòng)中（Starting）狀態(tài)，你可以調(diào)用 DescribeInstanceStatus 查看實(shí)例狀態(tài)，當(dāng)返回的狀態(tài)為Running時(shí)代表重啟成功。
使用須知
- 被安全鎖定的實(shí)例不能通過調(diào)用該接口重啟。更多信息，請(qǐng)參見資源安全鎖定對(duì)調(diào)用 API 的影響。
- ECS 實(shí)例的狀態(tài)必須為運(yùn)行中（
Running）。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ecs:RebootInstances | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DryRun | boolean | 否 | 是否只預(yù)檢此次請(qǐng)求。取值范圍：
說明
如果參數(shù) BatchOptimization被設(shè)置為SuccessFirst，對(duì)應(yīng)的DryRun=true的預(yù)檢結(jié)果只會(huì)返回DRYRUN.SUCCESS。
默認(rèn)值：false。 | false |
| RegionId | string | 是 | 實(shí)例所在的地域。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| ForceReboot | boolean | 否 | 是否強(qiáng)制重啟。取值范圍：
默認(rèn)值：false。 | false |
| BatchOptimization | string | 否 | 設(shè)置批量操作模式。取值范圍：
默認(rèn)值：AllTogether。 | AllTogether |
| InstanceId | array | 是 | 實(shí)例 ID 數(shù)組。數(shù)組長(zhǎng)度：1~100。 | |
| string | 是 | 實(shí)例 ID。 | i-bp67acfmxazb4p**** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"InstanceResponses": {
"InstanceResponse": [
{
"Code": "200",
"Message": "success",
"InstanceId": "i-bp1g6zv0ce8oghu7****",
"CurrentStatus": "Stopping",
"PreviousStatus": "Running"
}
]
}
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be added ECS tag | - |
| 400 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | 加密云盤設(shè)置了 KMSKeyId 后，CMK必須處于啟用狀態(tài)。您可以調(diào)用密鑰管理服務(wù)的 DescribeKey 接口查詢指定CMK的相關(guān)信息。 |
| 400 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service account have no right to access your KMS. | ECS 服務(wù)無權(quán)訪問您的 KMS |
| 400 | DRYRUN.SUCCESS | This request is a dryrun request with successful result. | 您設(shè)置了預(yù)檢此次請(qǐng)求，并且檢查通過。 |
| 403 | InvalidInstanceId.NotFound | InstanceId should not be null. | - |
| 403 | InvalidParameter.TooManyInstanceIds | Instance ids cannot be more than 100. | - |
| 403 | Abs.InvalidInstanceIds.MalFormed | The specified instanceIds is not valid. | 指定的InstanceId參數(shù)不合法 |
| 403 | InstanceLockedForSecurity | %s | - |
| 403 | InstanceExpiredOrInArrears | %s | - |
| 403 | IncorrectInstanceStatus | %s | 當(dāng)前實(shí)例的狀態(tài)不支持此操作。 |
| 403 | InvalidInstance.NotFoundSystemDisk | %s | 指定的實(shí)例ID未掛載系統(tǒng)盤，無法啟動(dòng)，具體信息請(qǐng)參見錯(cuò)誤信息%s占位符的實(shí)際返回結(jié)果。請(qǐng)先調(diào)用AttachDisk為指定的實(shí)例掛載系統(tǒng)盤。 |
| 403 | InsufficientBalance | Your account does not have enough balance. | 賬戶余額不足，請(qǐng)先充值再操作。 |
| 403 | InstanceNotReady | The specified instance is not ready for use. | 該資源目前的狀態(tài)不支持此操作，請(qǐng)您等待一段時(shí)間再進(jìn)行操作，并確認(rèn)實(shí)例目前狀態(tài)與操作是否沖突。 |
| 404 | InvalidInstanceId.NotFound | %s | 指定的實(shí)例不存在，請(qǐng)確認(rèn)參數(shù) InstanceId 是否正確。 |
| 404 | InvalidInstanceIds.NotFound | The specified InstanceIds does not exist. | 指定的 InstanceId 不存在。請(qǐng)檢查 InstanceId 參數(shù)值是否正確。您可以調(diào)用 DescribeInstances 查詢指定實(shí)例的狀態(tài)。 |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的InstanceId不存在。 |
| 409 | InvalidOperation.Conflict | Request was denied due to conflict with a previous request, please try again later. | 請(qǐng)求操作的資源與之前的請(qǐng)求沖突 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯(cuò)誤，請(qǐng)重試。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|