获取设备列表

最近更新时间:2019-04-30 15:17:05

1. 接口描述

本接口(ListDevices)用于查询物联网通信设备的设备列表。

接口请求域名:iotcloud.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 必选 类型 描述
pageSize Int 分页的大小,数值范围 10-100
pageNum Int 请求的页数
productID String 需要查看设备列表的产品 ID

3. 输出参数

参数名称 类型 描述
code Int 公共错误码。0 表示成功,其他值表示失败,详见 公共错误码 页面。
message String 模块错误信息描述,格式为 "(模块错误码)模块错误信息" 详见本页面的 模块错误码
codeDesc String 模块错误码的英文描述
totalCnt Int 设备总数
devices Array of Device 设备对象的数组

Device 的结构如下

参数名称 类型 描述
deviceName String 设备名称
productID String 产品 ID
online Int 在线状态,0 表示不在线,1 表示在线,2 表示获取设备在线状态失败
loginTime Long 设备登录时间
version String 设备固件版本号
lastUpdateTime Int 固件最后一次更新时间
isp Int NB-IoT设备的运营商类型,1为电信,2为移动,3为联通。目前只有电信
imei String NB-IoT设备的IMEI( 国际移动设备识别码 )。NB-IoT产品时此字段才有效

4. 示例

输入

  https://iotcloud.api.qcloud.com/v2/index.php?Action=ListDevices
  &productID=ABCDE12345&pageSize=10&pageNum=1
  &<公共请求参数>

输出

{
    "totalCnt": 2, 
    "devices": [
        {
            "deviceName": "device22", 
            "productID": "ABCDE12345",
            "online": 1,
            "loginTime": 1517802099,
            "version": "1.0",
            "lastUpdateTime": 1517800099
        }, 
        {
            "deviceName": "device21", 
            "productID": "ABCDE12345",
            "online": 0,
            "loginTime": 0,
            "version": "1.1",
            "lastUpdateTime": 1517801199
        }
    ],
    "message": "",
    "codeDesc": "Success",
    "code": 0
}

5. 模块错误码

模块错误码 描述
2004 分页参数非法
2100 内部服务器错误,请联系技术人员
2101 请求参数非法