查询设备在线信息

最近更新时间:2019-04-30 15:27:08

1. 接口描述

本接口(GetDeviceOnlineStatus)用于查询多个设备的在线信息。

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

注意:

同一用户账户下产品名称需保持唯一。

2. 输入参数

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

参数名称 必选 类型 描述
productID String 产品 ID。创建产品时腾讯云为用户分配全局唯一的 ID
listDeviceName Array of String 需要查询的设备名称,单次最多查询 100 个设备的在线信息。命名规则:[a-zA-Z0-9:_-]{1,48}
needLastDataTime Int 是否需要接口返回最后上行消息时间,0为不需要,1为需要。如不填写,默认值为0。为1时,单次最多查询设备数为16个

3. 输出参数

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

Device 的结构如下

参数名称 类型 描述
deviceName String 设备名称
online Int 在线状态,0 表示不在线,1 表示在线,2 表示获取设备在线状态失败
loginTime Int 设备登录时间,形式为UNIX时间戳,仅在设备在线时提供
lastDataTime Int 设备最后上行消息时间,如为0,表示输入参数needLastDataTime为0或者无消息上行

4. 示例

输入


  https://iotcloud.api.qcloud.com/v2/index.php?Action=GetDeviceOnlineStatus
  &productID=ABCDE12345
  &listDeviceName.0=apple
  &listDeviceName.1=banana
  &<公共请求参数>

输出

{
 "productID": "ABCDE12345",
 "totalCnt": 2,
 "devices": [{
   "deviceName": "apple",
   "online": 0
  },
  {
   "deviceName": "banana",
   "online": 1,
   "loginTime": 1522153767
  }
 ],
 "message": "",
 "codeDesc": "Success",
 "code": 0
}

5. 模块错误码

模块错误码 描述
2005 请求的设备不存在
2008 请求的产品不存在
2100 内部服务器错误,请联系客服
2101 ProductID非法或是请求的设备数超过限制