查询设备硬件配置信息

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

说明:

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

功能描述

DescribeDeviceHardwareInfo 接口用来查询设备的硬件配置信息,如 CPU 型号,内存大小,磁盘大小和个数。

接口访问域名:

bm.api.qcloud.com

请求

请求示例

https://bm.api.qcloud.com/v2/index.php?
    Action=DescribeDeviceHardwareInfo
    &<公共请求参数>    
    &instanceIds.0=<设备ID1>
    &instanceIds.1=<设备ID2>

请求参数

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

参数名称 必选 类型 描述
instanceIds Array(String) 设备 ID 列表

响应

响应示例

{
  "code": 0,
  "message": "",
  "codeDesc": "Success",
  "data": [{
        "instanceId": "cpm-3qrq1i82",
        "deviceClass": "Y0-BS05v1",
        "isElastic": "1",
        "cpmPayMode": "2",
        "cpuId": "1",
        "mem": "128",
        "haveRaidCard": "0",
        "diskTypeId1": "8",
        "diskNum1": "4",
        "diskTypeId2": 4,
        "diskNum2": 8,
        "cpuDesc": "E5-2620v3 (6\u6838)  * 2",
        "memDesc": "128G",
        "diskDesc": "4*SSD-SATA-480G+8*HDD-SATA-2T",
        "nicDesc": "10G*2",
        "raidDesc": "\u4e0d\u652f\u6301",
        "goodsDetail": {
            "pid": 10947,
            "bm_elastic_Y0-BS05": 1,
            "bm_elastic_SSD_480G": 4,
            "bm_elastic_SATA_2T_7200RTM": 8,
            "bm_elastic_MEM_32G": 4,
            "deviceClass": "Y0-BS05v1"
        }
    }]
}

响应参数

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

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

data 结构:

参数名称 类型 描述
instanceId String 设备实例 ID
deviceClass String 腾讯内部设备类型
isElastic Int 是否自定义机型
cpmPayMode Int 机型计费模式,1 为预付费,2 为后付费
cpuId Int 自定义机型,CPU 型号 ID
mem Int 自定义机型,内存大小, 单位 GB
haveRaidCard Int 是否有 RAID 卡,0:没有 RAID 卡; 1:有 RAID 卡
diskTypeId1 Int 自定义机型,第一种规格磁盘 ID
diskNum1 Int 自定义机型,第一种规格磁盘个数
diskTypeId2 Int 自定义机型,第二种规格磁盘 ID
diskNum2 Int 自定义机型,第二种规格磁盘个数
cpuDesc String CPU 型号描述
memDesc String 内存描述
diskDesc String 磁盘描述
nicDesc String 网卡描述
raidDesc String 是否支持 RAID 的描述
goodsDetail Array 计费相关的 ID,可以不用关注

错误码

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

实际案例

请求

https://bm.api.qcloud.com/v2/index.php?
Action=DescribeDeviceHardwareInfo
&Nonce=1187296601&Region=bj
&Timestamp=1508763150
&SecretId=AKID52SKw5uMEy3jhpMUBqSylEBJBby6E0KC
&instanceIds.0=cpm-cjm505sb
&instanceIds.1=cpm-1nk36wcj
&Signature=XynD%2FHNX7Aj42SiMU18L7gIOVZQ%3D

响应

{
  "code": 0,
  "message": "",
  "codeDesc": "Success",
  "data": [{
        "instanceId": "cpm-3qrq1i82",
        "deviceClass": "Y0-BS05v1",
        "isElastic": "1",
        "cpmPayMode": "2",
        "cpuId": "1",
        "mem": "128",
        "haveRaidCard": "0",
        "diskTypeId1": "8",
        "diskNum1": "4",
        "diskTypeId2": 4,
        "diskNum2": 8,
        "cpuDesc": "E5-2620v3 (6\u6838)  * 2",
        "memDesc": "128G",
        "diskDesc": "4*SSD-SATA-480G+8*HDD-SATA-2T",
        "nicDesc": "10G*2",
        "raidDesc": "\u4e0d\u652f\u6301",
        "goodsDetail": {
            "pid": 10947,
            "bm_elastic_Y0-BS05": 1,
            "bm_elastic_SSD_480G": 4,
            "bm_elastic_SATA_2T_7200RTM": 8,
            "bm_elastic_MEM_32G": 4,
            "deviceClass": "Y0-BS05v1"
        }
    }]
}