本接口用于重启一台ECS实例。
接口说明
该接口为异步接口,实例的重启不是立即完成的,成功调用后,实例会先进入启动中(Starting)状态,你可以调用 DescribeInstanceStatus 查看实例状态,当返回的状态为Running时代表重启成功。
使用须知
被安全锁定的实例不能通过调用该接口重启。更多信息,请参见资源安全锁定对调用 API 的影响。
您只能重启状态为运行中(
Running)的 ECS 实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:RebootInstance |
update |
*Instance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
指定实例的 ID。 |
i-bp67acfmxazb4ph**** |
| ForceStop |
boolean |
否 |
重启 ECS 实例前,是否强制关机。取值范围:
默认值:false。 |
false |
| DryRun |
boolean |
否 |
是否只预检此次请求。取值范围:
默认值:false。 |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
异常返回示例
JSON格式
{
"RequestId": "F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 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 | InvalidParameter.KMSKeyId.CMKUnauthorized | %s | |
| 403 | InvalidParameter.KMSKeyId.CMKNotEnabled | %s | |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | %s | |
| 403 | OperationDenied.KMSKeyUnauthorized | The operation is denied due to missing KMS key authorization. Please check the KMS key permissions and ensure the key is properly authorized for this operation. | |
| 404 | InvalidParameter.KMSKeyId.NotFound | %s | |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的实例ID无效。 |
| 503 | LimitedOperation.ServiceUnavailable | The service is currently unavailable. Please try again later. | 当前服务不可用。请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。