说明

该接口用于查询企业在云平台创建的产品详情

接口

/product/query

调用方式

GET

请求参数

名称 类型 必填 说明
product_key string 产品的唯一标识。说明:用户在平台申请创建产品,平台审核通过之后,生成产品的唯一标识符。
公共请求参数 - 详见公共参数部分

返回参数(json 格式)

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

data表

名称 类型 描述
category_id int 产品分类id
category_name string 产品分类名称。说明:开发者在物联网平台上,可以根据产品属性,选择产品所对应的分类名称,如:生活电器-扫地机器人
product_name string 产品的名称,由开发者创建产品时填写
english_name string 产品的英文名称,由开发者创建产品时填写
product_key string 产品的唯一标识符。说明:创建产品时, 由云平台生成
product_secret string 产品秘钥,应当谨慎保管,避免泄漏。说明:产品秘钥用于一型一密等场景
product_type int 产品类型。枚举值: 1:表示网关类型设备,网关可以挂载子设备,具有子设备管理模块,维持子设备的拓扑关系,并且可以将拓扑关系同步到云端。2:表示普通类型设备,设备不能挂载子设备
description string 产品的描述,由开发者创建产品时填写
access_type int 接入类型。枚举值: 1:硬件直连到云平台。2:通过云云对接的方式接入平台
callback_url string 当access_type=2时,该字段有效。云平台对云云对接的产品进行控制时,回调的地址
protocol int 当access_type=1时,该字段有效。产品下的设备与平台数据通信的格式,枚举值: 1: XLink协议(数据格式为JSON),2:其他协议
initial_version string 固件初始版本号
model string 产品型号,创建产品时,用户填写
logo string 产品的logo地址,由用户在创建产品时上传
os string 当access_type=2时,该字段有效。产品所支持的操作系统
network string 当access_type=2时,该字段有效。产品联网方式,目前支持如下方式:WiFi,234G,Ethernet,Other
network_init_type int 当access_type=2时,该字段有效。产品配网方式,枚举值,目前支持如下: 1: 一键配网,4: 设备热点配网
is_linked int 当product_type=2时,该字段有效。普通产品是否接入网关。枚举值: 0:否,1:是
linked_protocol string 当产品为网关产品时,该字段为允许子设备接入的协议,当产品为普通产品且设置为接入网关时,该字段为允许接入网关产品的协议。目前之前如下接入协议:WiFi,Zigbee,BLE,LoRaWan,2/3/4G,Ethernet,其他
linked_desc string 当linked_protocol=其他时,该字段为接入协议的描述
status int 产品当前状态,保留字段。0: 正常
create_ts string 设备的创建时间(时间戳,秒)
modify_ts string 设备信息修改的时间(时间戳, 秒)

返回示例

  1. {
  2. "request_id": "34d87b87-bbc7-4ce3-84fe-2a012f059355",
  3. "errno": 0,
  4. "errmsg": "",
  5. "data": {
  6. "category_id": "",
  7. "category_name": "",
  8. "product_name": "",
  9. "english_name": "",
  10. "product_key": "",
  11. "product_secret": "",
  12. "product_type": "",
  13. "description": "",
  14. "access_type": "",
  15. "callback_url": "",
  16. "protocol": "",
  17. "initial_version": "",
  18. "logo": "",
  19. "model": "",
  20. "os": "",
  21. "network": "",
  22. "network_init_type": "",
  23. "linked_protocol": "",
  24. "linked_desc": "",
  25. "is_linked": "",
  26. "status": 0,
  27. "create_ts": " 1568884081",
  28. "modify_ts": " 1568884081"
  29. }
  30. }
即刻开始使用

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