查询回收站服务器

最近更新时间:2019-06-17 18:00:09

说明:

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

功能描述

DescribeDeviceTrash 接口用来查询回收站服务器列表。

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

请求

请求示例

https://bm.api.qcloud.com/v2/index.php?
Action=DescribeDeviceTrash
&<公共请求参数>
&offset=<偏移量>
&limit=<查询返回物理机的数量>
&unVpcId=<私有网络的ID>
&deviceClassCode=<设备类型>
&instanceIds.0=<设备ID1>
&instanceIds.1=<设备ID2>
&lanIps.0=<业务内网IP1>
&lanIps.1=<业务内网IP2>
&alias=<实例名>

请求参数

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

参数名称 必选 类型 描述
offset Int 偏移量,默认为0。
limit Int 查询返回物理机的数量,默认为20。
unVpcId String 私有网络 ID。通过接口 查询私有网络列表(DescribeBmVpcEx) 获取私有网络信息,取 unVpcId 字段,如 vpc-8e0ypm3z。
unSubnetId String 子网 ID。 通过接口 查询子网列表(DescribeBmSubnetEx) 获取私有子网信息,取 unSubnetId 字段,如 subnet-34xt45as。
deviceClassCode String 设备类型,通过接口 DescribeDeviceClass 获得设备类型信息。
lanIps Array(String) 业务内网 IP 列表。
wanIps Array(String) 外网 IP 列表。
instanceIds Array(String) 设备 ID 列表。
alias String 设备别名,模糊查询。

响应

响应示例

{
"code": 0,
"message": "OK",
"data": {
"totalNum": 1,
"deviceList": [
{
"instanceId": "cpm-xxxxxx",
"subnetId": "3406",
"vpcId": "1479",
"lanIp": "10.100.1.30",
"deviceStatus": "12",
"operateStatus": "1",
"osTypeId": "2",
"raidId": "6",
"alias": "data-dn30",
"raid": "NORAID",
"appId": "1254024480",
"zoneId": "1000800002",
"projectId": "0",
"wanIp": "",
"deviceClass": "TS60",
"deviceClassCode": "PI102v1",
"deliverTime": "2017-12-18 12:25:09",
"deadline": "2018-08-18 12:25:09",
"operates": [],
"vpcName": "beijing-vpc-heishi-data",
"subnetName": "beijing-vpc-heishi-data-hadoop",
"unVpcId": "vpc-goh9xf63",
"unSubnetId": "subnet-hsa5maho",
"vpcCidrBlock": "10.100.0.0/16",
"subnetCidrBlock": "10.100.1.0/24",
"osName": "BM-centos7.2",
"osNameDisplay": "Centos 7.2 64位",
"raidDisplay": "NO RAID",
"autoRenewFlag":0
}
],
"serverTimestamp": 1464164820301
}
}

响应参数

响应参数部分包含两层结构,外层展示接口的响应结果,内层展示具体的接口内容,包括服务器等信息。

参数名称 类型 描述
code Int 错误码,0:成功, 其他值:失败,具体含义参见 错误码
message String 错误信息。
data Object 设备列表,具体结构描述如 data 结构所示。

data结构

参数名称 类型 描述
totalNum Int 设备总数
deviceList Array(Object) 对象数组。数组元素为设备信息,具体结构描述如 deviceList 结构所示。

deviceList 结构

参数名称 类型 描述
instanceId String 设备 ID。
vpcId Int 私有网络 ID,整型格式。
subnetId Int 私有子网 ID,整型格式。
unVpcId String 私有网络 ID,字符串格式。
unSubnetId String 私有子网 ID,字符串格式。
deviceStatus Int 设备的运营状态。状态详细描述见下面表格。
operateStatus Int 设备的操作状态。 状态详细描述见下面表格。
osTypeId Int 操作系统 ID。操作系统含义参见接口 查询操作系统列表(DescribeOs)
raidId Int RAID 方式 ID。RAID 含义参见接口 查询机型 RAID 方式以及系统盘大小(DescribeDeviceClassPartition)
alias String 设备别名。
wanIp String 弹性 IP。
lanIp String 业务内网 IP。
deliverTime String 设备交付时间。
deadline String 设备到期时间。
autoRenewFlag Int 自动续费标志。0:不自动续费,1:自动续费。
deviceClass String 设备类型。
deviceClassCode String 腾讯云售卖设备类型。
tagDetail Array(Object) 对象数组。设备标签列表,具体结构描述如 tagDetail 结构所示。

tagDetail结构

参数名称 类型 描述
key String 标签键
value String 标签值

设备的运营状态

状态 ID 含义
1 申领设备中
2 正在初始化设备
3 初始化失败
4 运营中
5 硬件故障
6 网络配置故障
7 正在隔离
8 已隔离
9 隔离失败
10 正在解隔离
11 解隔离失败
12 正在下线
13 已下线
14 到期

设备的操作状态

状态 ID 含义
1 运行中
2 正在关机
3 已关机
4 关机失败
5 正在开机
6 开机失败
7 正在重启
8 重启失败
9 正在重装系统
10 重装失败
11 正在重置密码
12 绑定弹性IP
13 解绑弹性IP
14 绑定负载均衡
15 解绑负载均衡

错误码

错误码 英文提示 错误描述
9001 InternalError.DbError 操作数据库错误
10001 InvalidParameter 参数错误

实际案例

输入

https://bm.api.qcloud.com/v2/index.php?
Action=DescribeDeviceTrash
&SecretId=AKID52SKw5uMEy3jhpMUBqSylEBJBby6E0KC
&Nonce=48476
&Timestamp=1476436689
&Region=bj
&Signature=afRlJQ0disdT97B7uIfVB4v2KWo%3D
&offset=1
&limit=30
&unVpcId=vpc-8e0ypm3z
&deviceClass=M10
&instanceIds.0=cpm-34xw423x
&instanceIds.1=cpm-34xw234y
&lanIps.0=10.1.1.1
&lanIps.1=10.1.2.2
&alias=实例名

输出

{
"code": 0,
"message": "OK",
"data": {
"totalNum": 1,
"deviceList": [
{
"instanceId": "cpm-xxxxxx",
"subnetId": "3406",
"vpcId": "1479",
"lanIp": "10.100.1.30",
"deviceStatus": "12",
"operateStatus": "1",
"osTypeId": "2",
"raidId": "6",
"alias": "data-dn30",
"raid": "NORAID",
"appId": "1254024480",
"zoneId": "1000800002",
"projectId": "0",
"wanIp": "",
"deviceClass": "TS60",
"deviceClassCode": "PI102v1",
"deliverTime": "2017-12-18 12:25:09",
"deadline": "2018-08-18 12:25:09",
"operates": [],
"vpcName": "beijing-vpc-heishi-data",
"subnetName": "beijing-vpc-heishi-data-hadoop",
"unVpcId": "vpc-goh9xf63",
"unSubnetId": "subnet-hsa5maho",
"vpcCidrBlock": "10.100.0.0/16",
"subnetCidrBlock": "10.100.1.0/24",
"osName": "BM-centos7.2",
"osNameDisplay": "Centos 7.2 64位",
"raidDisplay": "NO RAID",
"autoRenewFlag":0
}
],
"serverTimestamp": 1464164820301
}
}