You need to enable JavaScript to run this app.
导航
RebootInstance - 重启一台实例
最近更新时间:2024.10.28 17:36:24首次发布时间:2021.07.31 07:48:16

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

使用说明

只有处于 运行中  状态的实例,才支持重启操作。

注意事项

  • 使用本接口重启裸金属实例可能导致实例数据丢失,请通过云服务器控制台完成重启操作。
  • 实例重启会短暂中断您的业务,请谨慎操作。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

RebootInstance

要执行的操作,取值:RebootInstance。

Version
String

2020-04-01

API的版本,取值:2020-04-01。

ForceStop
Boolean

false

重启实例前是否强制关机,取值:

  • true:强制关机。相当于典型的断电操作,所有未写入存储设备的缓存数据会丢失。
  • false(默认):正常关机。

说明

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

  • 弹性裸金属实例。
  • 高性能计算GPU型ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2实例。

    ebmhpcpni2l 、ebmhpcpni2、ebmhpchfpni2正在邀测中,如需试用,请联系客户经理申请。

ClientToken
String

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。
取值:仅支持ASCII字符,且不能超过64个字符。

DryRun
Boolean

false

是否只预检此次请求。

  • 取值:true:发送检查请求,不会重启实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation。
  • false(默认):发送正常请求,通过检查后直接重启实例。
InstanceId
String

i-3tiefmkskq3vj0x0****

实例ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

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": {}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidArgument
The specified argument is invalid.

指定的参数不合法。

400
InvalidInstanceStatus
The status of the specified instance does not support this request.

当前实例的状态不支持此操作。

400
MissingParameter.InstanceId
The required parameter InstanceId is not supplied.

参数实例ID不能为空。

400
IdempotentParameterMismatch
The 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.

幂等参数不一致。

400
Insufficient.Balance
The request is denied due to the lack of balance.

账户余额不足。

400
InvalidClientToken.Malformed
The specified ClientToken is malformed.

指定的ClientToken不合法。

400
InvalidDedicatedHostStatus.Unsupported
The status of the specified dedicated host does not support this request.

当前专有宿主机的状态不支持此操作。

403
InvalidInstance.RequestForbidden
Request is forbidden by the server.

由于您的火山引擎账户违反了相关规定,指定的资源已不再可以使用,如需恢复服务请提交工单联系服务人员处理。

404
InvalidInstance.NotFound
The specified instance does not exist.

指定的实例不存在。

412
OperationDenied.ResourceCreatedByOtherService
The specified operation is denied as your resource is created by other service. You can check system tags to find the service.

指定的操作被拒绝,因为您的资源被其他服务创建。您可以通过资源的系统标签查询对应服务。

412
OperationDenied.ResourceLocked
The specified operation is denied as your resource is locked for another operation.

指定的操作被拒绝,因为您的资源已被其他操作锁定。

412
DryRunOperation
Your request has been validated by the DryRunOperation.

通过“DryRun”校验,您的请求已通过验证。

412
IdempotentProcessing
The request uses the same client token as a previous one that is still in process.

先前的幂等请求仍在处理中,请稍后重试。

412
OperationDenied.InstanceIsCreatingImage
The specified operation is denied as your instance is creating image.

指定的操作被拒绝,因为该实例正在创建自定义镜像。

500
InternalError
An internal error has occurred.

内部错误,请重试。如果多次尝试失败,请提交工单。