docs: add OneNET API reference documentation
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,71 @@
|
||||
接口地址
|
||||
|
||||
https://iot-api.heclouds.com/product/detail
|
||||
|
||||
API说明
|
||||
|
||||
请求方式:GET
|
||||
|
||||
http query 请求参数
|
||||
|
||||
参数名称 格式 是否必选 说明
|
||||
product_id string 是 产品ID
|
||||
返回数据
|
||||
|
||||
参数名称 类型 描述
|
||||
code int 错误码,当为0时表示请求成功,取值见错误码说明表
|
||||
msg string 错误描述信息
|
||||
request_id string API请求链路id
|
||||
data - 具体响应内容
|
||||
data.product_id string 产品id
|
||||
data.access_protocol int 接入协议,取值见接入协议取值说明表
|
||||
data.data_protocol int 数据协议,取值见数据协议取值说明表
|
||||
data.name string 产品名称
|
||||
data.node_type string 节点类型,1-直连设备;2-网关设备;3-子设备
|
||||
data.create_time datetime 产品创建时间
|
||||
data.update_time datetime 最近修改时间
|
||||
data.network string 联网方式
|
||||
data.manufacturer string 产品厂商
|
||||
data.model string 产品型号
|
||||
data.brand string 产品品牌
|
||||
data.desc string 产品描述
|
||||
data.status int 开发状态 1-开发中;2-审核中;3-审核未通过;4-已发布;5-已下架
|
||||
data.own_device_count int 自有设备总数, 缓存时效为5分钟
|
||||
data.online_device_count int 在线设备总数, 缓存时效为5分钟
|
||||
data.offline_device_count int 离线设备数, 缓存时效为5分钟
|
||||
data.not_active_device_count int 未激活设备数, 缓存时效为5分钟
|
||||
data.query_time int64 查询时间(毫秒时间戳)
|
||||
data.viot_app_id string 视频类产品返回,用于视频播放器sdk集成参数
|
||||
示例
|
||||
|
||||
请求示例:
|
||||
|
||||
https://iot-api.heclouds.com/product/detail?product_id=123
|
||||
响应示例:
|
||||
|
||||
{
|
||||
"code": 0,
|
||||
"data": {
|
||||
"product_id": "fupcJIVEuz",
|
||||
"name": "MQTT-测试产品",
|
||||
"node_type": 1,
|
||||
"access_protocol": 2,
|
||||
"data_protocol": 1,
|
||||
"network": "2",
|
||||
"manufacturer": "",
|
||||
"model": "",
|
||||
"brand": "",
|
||||
"desc": "",
|
||||
"create_time": "2024-08-20T08:43:05.915Z",
|
||||
"update_time": "2024-08-20T08:43:56.346Z",
|
||||
"status": 4,
|
||||
"viot_app_id": "aaaaaaaaaaaaaaaaa",
|
||||
"own_device_count": 1, //缓存时效为5分钟
|
||||
"online_device_count": 0,//缓存时效为5分钟
|
||||
"offline_device_count": 0,//缓存时效为5分钟
|
||||
"not_active_device_count": 1,//缓存时效为5分钟
|
||||
"query_time": 1732097555350
|
||||
},
|
||||
"msg": "succ",
|
||||
"request_id": "b5ed8d0500994f1b8784101b3c8f73d7"
|
||||
}
|
||||
Reference in New Issue
Block a user