本接口用于重启一台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. | 指定的实例ID未找到。 |
| 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 错误码发生变更 | 查看变更详情 |