You need to enable JavaScript to run this app.
导航
RebootInstances - 重启实例
最近更新时间:2024.09.29 11:41:08首次发布时间:2022.07.01 09:15:47

调用 RebootInstances 接口重启一台或多台实例。

注意事项

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

调试

请求参数

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

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

RebootInstances

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

Version
String

2020-04-01

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

ClientToken
String

333456899ff****

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

ForceStop
Boolean

false

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

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

说明

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

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

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

InstanceIds.N
Array of String

InstanceIds.1=i-ybo349sxoncm9t******&InstanceIds.2=i-ybo349sxolcm9t******

实例ID,最多支持100个ID。

  • 参数 - N:表示实例的序号。
  • 多个Instance ID之间用&分隔。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

说明

仅当请求参数输入不合法时提示下文中的接口错误码。若请求参数输入无误,将不会提示接口错误码,且接口的返回状态码将为200,但这并不代表对所有实例的操作均已成功,单个实例的操作结果请参见如下返回参数中的信息。

参数
类型
示例值
描述
OperationDetails
Array of Object

--

操作详情。

请求示例

GET /?Action=RebootInstances&Version=2020-04-01&InstanceIds.1=i-ybo349sxoncm9t******&InstanceIds.2=i-ybo349sxolcm9t****** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "RebootInstances",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "OperationDetails": [
            {
                "InstanceId": "i-ybo349sxoncm9t******",
                "Error": {
                    "Code": "InvalidInstanceStatus",
                    "Message": "The status of the specified instance does not support this request."
                }
            },
            {
                "InstanceId": "i-ybo349sxolcm9t******",
                "Error": {
                    "Code": "InvalidInstance.NotFound",
                    "Message": "The specified instance does not exist."
                }
            }
        ]
    }
}

错误码

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

状态码
错误码
错误信息
说明
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
InvalidArgument
The specified argument is invalid.

指定的参数不合法。

400
InvalidClientToken.Malformed
The specified ClientToken is malformed.

指定的ClientToken不合法。

400
InvalidCount.Malformed
The specified count is malformed.

指定的参数Count不合法。

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

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

403
InvalidInstance.RequestForbidden
Request is forbidden by the server.

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

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

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

500
InternalError
An internal error has occurred.

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