全部产品
Search

搜索本产品

    云服务器 ECS：RebootInstance - 重启实例

    文档中心

    云服务器 ECS：RebootInstance - 重启实例

    更新时间：Nov 14, 2024

    本接口用于重启一台ECS实例。

    接口说明

    该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入启动中（Starting）状态，你可以调用 DescribeInstanceStatus 查看实例状态，当返回的状态为Running时代表重启成功。

    使用须知

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    ecs:RebootInstanceupdate
    *Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    指定实例的 ID。

    		i-bp67acfmxazb4ph****
    ForceStopboolean否

    重启 ECS 实例前，是否强制关机。取值范围：

    • true：强制关机。相当于典型的断电操作，所有未写入存储设备的缓存数据会丢失。

    • false：正常关机。

    默认值：false。

    		false
    DryRunboolean否

    是否只预检此次请求。取值范围：

    • true：发送检查请求，不会重启实例。检查项包括是否填写了必选参数、请求格式、业务限制和 ECS 库存。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
    • false：发送正常请求，通过检查后直接重启实例。

    默认值：false。

    		false

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

    错误码

    HTTP status code错误码错误信息描述
    403IncorrectInstanceStatusThe current status of the resource does not support this operation.该资源目前的状态不支持此操作。
    403InstanceLockedForSecurityThe specified operation is denied as your instance is locked for security reasons.实例被安全锁定。
    403DiskErrorIncorrectDiskStatus.指定的磁盘状态不合法。
    403InstanceExpiredOrInArrearsThe specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode).实例已过期或者欠费，请您续费或者结清后再进行操作。
    403IncorrectInstanceStatus%s当前实例的状态不支持此操作。
    403InvalidParameter.KMSKeyId.CMKUnauthorized%s-
    403InvalidParameter.KMSKeyId.CMKNotEnabled%s-
    403InvalidParameter.KMSKeyId.KMSUnauthorized%s-
    404InvalidParameter.KMSKeyId.NotFound%s-
    404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的实例ID未找到。
    500InternalErrorThe request processing has failed due to some unknown error.内部错误，请重试。
    500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误，请重试。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-07-17OpenAPI 错误码发生变更查看变更详情