说明

该接口用于查询已创建的产品下设备列表

接口

/device/getProductDeviceList

调用方式

GET

请求参数

名称 类型 必填 说明
product_key string 产品的唯一标识(云平台生成).说明:用户在平台申请创建产品,平台审核通 过之后,生成该产品的唯一标识符
page int 当前设备列表的页码,默认值为 1.
size int 当前设备列表中数量,默认值为 10.
公共请求参数 详见公共参数部分

返回参数(json 格式)

名称 类型 描述
request_id string 云平台为该请求生成的唯一标识符
errmsg string 调用失败时,返回的出错信息
errno number errno 等于 0 表示成功,其他表示失败
data data 调用成功时,返回的数据。详情请见下表 data

data表

名称 类型 描述
total_count int 当前企业下所有产品的设备数量累加总数。
list array of device 该企业下设备集合列表, list 中包含多个 device 对 象,每个对象详细见下面 device 表说明: 该列表内容由传参中的 page 及 size 确定。

device list表

名称 类型 描述
product_name string 产品的名称
product_key string 产品的唯一标识符。说明:此处返回值为创建设备时的传参参数
device_name string 设备的名称,该产品下设备的唯一标识。说明:若创建设备时,未传该参数,则系统自动生成。
device_secret string 设备秘钥,用户应当谨慎保管,避免泄漏。说明:设备秘钥用于设备接入云平台时,平台对设备身份进 行鉴权,对设备参数进行校验等
device_attributes map<key>val 设备的属性,用户在创建设备时所传参数。为 map 对象。说明: 若用户创建设备时,此参数传参为空,则该处为空对象
product_type int 设备的类型。枚举类型: 1:表示网关类型设备,网关可以挂载子设备,具有 子设备管理模块,维持子设备的拓扑关系,并且可 以将拓扑关系同步到云端 2:表示普通类型设备,设备不能挂载子设备
device_status string 表示设备当前状态。枚举类型: unactive:表示尚未激活 active:表示已激活 online:表示设备当前在线 offline:表示设备当前已离线 。说明: 当设备被创建时,默认为 unactive 状态; 当设备第一次接入云平台则自动置为激活状态; 当设备与平台建立并保持连接时,则表示设备当前在线; 当设备断开与平台的连接时,则表示离线。
create_ts string 设备的创建时间(时间戳)
modify_ts string 设备信息修改的时间(时间戳)
recent_online_time string 设备最近一次在线时间(时间戳)
recent_offline_time string 设备最近一次离线时间(时间戳)
activate_ts string 设备激活时间戳
test_flag string 设备标记: 1:普通设备;2测试设备;3虚拟设备

返回示例

  1. {
  2. "request_id":"34d87b87-bbc7-4ce3-84fe-2a012f059355",
  3. "errno":0,
  4. "errmsg":"",
  5. "data":{
  6. "total_count":27,
  7. "list":[
  8. {
  9. "product_name":"产品名称",
  10. "product_key":"pk",
  11. "device_name":"dn",
  12. "device_secret":"ds",
  13. "device_attributes":{
  14. },
  15. "product_type":1,
  16. "device_status":"offline",
  17. "create_ts":"1568884081",
  18. "modify_ts":" 1568884081",
  19. "recent_online_time":"1568884081",
  20. "recent_offline_time":"1568884081",
  21. "activate_ts":"1568884081",
  22. "test_flag":1
  23. },
  24. {
  25. "product_name":"产品名称",
  26. "product_key":"pk",
  27. "device_name":"dn",
  28. "device_secret":"ds",
  29. "device_attributes":{
  30. },
  31. "product_type":1,
  32. "device_status":"offline",
  33. "create_ts":"1568884081",
  34. "modify_ts":" 1568884081",
  35. "recent_online_time":"1568884081",
  36. "recent_offline_time":"1568884081",
  37. "activate_ts":"1568884081",
  38. "test_flag":1
  39. }
  40. ]
  41. }
  42. }
即刻开始使用

只需完成注册与实名认证,即可体验我们的贴心服务