API 文档

重启服务器

最近更新时间:2019-06-17 17:04:10

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。黑石物理服务器1.0 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 黑石物理服务器1.0 API 3.0

功能描述

RebootDevice 接口用来重启服务器。

接口访问域名:bm.api.qcloud.com

说明:

为规避误操作风险,黑石产品目前对重启操作做了频率限制:每分钟可以操作重启的设备总数上限为100台。

请求

请求示例

https://bm.api.qcloud.com/v2/index.php?Action=RebootDevice
    &<公共请求参数>
    &instanceIds.1=<设备ID1>
    &instanceIds.2=<设备ID2>
    &opUin=<操作者QQ号>

请求参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,其它参数参见 公共请求参数 页面。其中,此接口的 Action 字段为 RebootDevice。

参数名称 必选 类型 描述
instanceIds Array(String) 设备 ID 列表。
opUin String 操作者 QQ 号。

响应

响应示例

{
  "code": 0,
  "message": "OK",
  "data": {
       "taskId": 101
   }
}

响应参数

响应参数部分包含两层结构,外层展示接口的响应结果,内层展示具体的接口内容,包括异步操作的ID等信息。

参数名称 类型 描述
code Int 错误码,0:成功,其他值: 失败,具体含义参见 错误码
message String 错误信息。
data Object 返回异步操作的 ID 信息,具体结构描述如 data 结构所示。

data结构

参数名称 类型 描述
taskId Int 以 taskId 为 key,对应的值为异步操作的 ID。

错误码

错误码 英文提示 错误描述
9001 InternalError.DbError 操作数据库错误
9005 InternalError.RbmqError 操作系统队列错误
10001 InvalidParameter 参数错误
12002 OperationDenied.IncorrectInstanceStatus 设备不能被重启

实际案例

输入

https://bm.api.qcloud.com/v2/index.php?
    Action=RebootDevice
    &SecretId=AKID52SKw5uMEy3jhpMUBqSylEBJBby6E0KC
    &Nonce=48476
    &Timestamp=1476436689
    &Region=bj
    &Signature=afRlJQ0disdT97B7uIfVB4v2KWo%3D
    &instanceIds.1=cpm-34xs43xs
    &instanceIds.2=cpm-34xs43ab
    &opUin=23234234  

输出

{
  "code": 0,
  "message": "OK",
  "data": {
       "taskId": 101
   }
}
目录