You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

RebootInstance

最近更新时间：2023.11.20 10:48:34

首次发布时间：2021.07.31 07:48:16

我的收藏

调用 RebootInstance 接口重启一台实例。

接口说明

使用本接口重启裸金属实例可能导致实例数据丢失，请通过云服务器控制台完成重启操作。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必填
示例值
描述
ActionString是RebootInstance要执行的操作，取值：RebootInstance。
VersionString是2020-04-01API的版本，取值：2020-04-01。
InstanceIdString是i-3tiefmkskq3vj0******实例ID。

ForceStop

Boolean

否

false

重启实例前是否强制关机，取值：

  • false（默认值）：正常关机。

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

说明

以下类型的实例，ForceStop无论取值为true还是false，实例均会执行强制关机。

  • 弹性裸金属实例

  • 高性能计算GPU型ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2

    ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2正在邀测中，如需试用，请提交工单或联系客户经理申请。

ClientToken

String

否

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

取值：仅支持ASCII字符，且不能超过64个字符。

DryRun

Boolean

否

false

是否只预检此次请求，取值：

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

  • false（默认）：发送正常请求，通过检查后直接重启实例。

返回数据

操作接口仅返回公共参数及错误码。

请求示例

GET /?Action=RebootInstance&Version=2020-04-01&InstanceId=i-3tiefmkskq3vj0****** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210623195036010225145152013****",
        "Action": "RebootInstance",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

HttpCode错误码错误信息描述
400MissingParameter.InstanceIdThe required parameter InstanceId is not supplied.实例ID不能为空。
400InvalidInstanceStatusThe status of the specified instance does not support this request.当前实例的状态不支持此操作。
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
400Insufficient.BalanceThe request is denied due to the lack of balance.账户余额不足。
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.幂等参数不一致。
400InvalidClientToken.MalformedThe specified ClientToken is malformed.指定的ClientToken不合法。
404InvalidInstance.NotFoundThe specified instance does not exist.指定的实例不存在。
412OperationDenied.ResourceLockedThe specified operation is denied as your resource is locked for another operation.指定的操作被拒绝，因为您的资源已被其他操作锁定。
412OperationDenied.ResourceCreatedByOtherServiceThe specified operation is denied as your resource is created by other service. You can check system tags to find the service.指定的操作被拒绝，因为您的资源被其他服务创建。您可以通过资源的系统标签查询对应服务。
412OperationDenied.InstanceIsCreatingImageThe specified operation is denied as your instance is creating image.指定的操作被拒绝，因为您的实例正在创建自定义镜像。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.先前的幂等请求仍在处理中，请稍后重试。
412DryRunOperationYour request has been validated by the DryRunOperation.通过“DryRun”校验，您的请求已通过验证。
500InternalErrorAn internal error has occurred.内部错误，请重试。如果多次尝试失败，请提交工单。