docs: add OneNET API reference documentation
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,102 @@
|
||||
设备列表
|
||||
最近更新时间:2025-12-22 10:38:50
|
||||
接口说明
|
||||
用于查询产品下的设备列表,支持通过设备名称左前缀模糊匹配。
|
||||
|
||||
接口地址
|
||||
https://iot-api.heclouds.com/device/list
|
||||
|
||||
API说明
|
||||
请求方式:GET
|
||||
|
||||
http query 请求参数
|
||||
|
||||
参数名称 格式 是否必选 说明
|
||||
product_id string 是 产品ID
|
||||
device_name string 否 设备名称(左前缀模糊匹配)
|
||||
offset int 否 查询起始下标,默认为0
|
||||
limit int 否 单次查询数量限额,默认为10,最大为100
|
||||
返回数据
|
||||
|
||||
参数名称 类型 描述
|
||||
code int 错误码,当为0时表示请求成功,取值见错误码说明表
|
||||
msg string 错误描述信息
|
||||
request_id string API请求链路id
|
||||
data - 具体响应内容
|
||||
data.list[0].did int/string 设备id
|
||||
data.list[0].pid string 产品id
|
||||
data.list[0].access_pt int 接入协议,取值见接入协议取值说明表
|
||||
data.list[0].data_pt int 数据协议,取值见数据协议取值说明表
|
||||
data.list[0].name string 设备名称
|
||||
data.list[0].desc string 设备描述
|
||||
data.list[0].status int 设备状态,0-离线,1-在线,2-未激活
|
||||
data.list[0].create_time datetime 设备创建时间
|
||||
data.list[0].activate_time datetime 设备激活时间
|
||||
data.list[0].last_time datetime 设备最后一次在线时间
|
||||
data.list[0].sec_key string 设备接入鉴权key
|
||||
data.list[0].imei string LwM2M设备imei
|
||||
data.list[0].imsi string LwM2M设备imsi
|
||||
data.list[0].psk string LwM2M设备psk
|
||||
data.list[0].auth_code string LwM2M设备auth_code
|
||||
data.list[0].intelligent_way int 产品智能化方式,1-设备接入、2-产品智能化
|
||||
data.list[0].group_id string 设备分组id
|
||||
data.list[0].enable_status bool 设备启用状态
|
||||
data.list[0].lon string 经度
|
||||
data.list[0].lat string 纬度
|
||||
data.list[0].obsv bool 设备资源自动订阅是否启用
|
||||
data.list[0].obsv_st bool 设备资源自动订阅状态
|
||||
data.list[0].private bool 设备私密性
|
||||
data.list[0].imsi_old string-array 设备imsi历史变更记录
|
||||
data.list[0].imsi_mt datetime 设备imsi最近一次修改时间
|
||||
data.list[0].viot_device_sn string 移动视联网设备返回唯一标识
|
||||
data.list[0].viot_protocol int 移动视联网设备返回接入协议
|
||||
1-GB28181协议
|
||||
2-千里眼协议
|
||||
data.offset int 查询起始下标
|
||||
data.limit int 单次查询数量限额
|
||||
示例
|
||||
请求示例:
|
||||
|
||||
GET https://iot-api.heclouds.com/device/list?product_id=43770&device_name=&offset=0&limit=10
|
||||
响应示例:
|
||||
|
||||
{
|
||||
"code": 0,
|
||||
"data":{
|
||||
"list":[{
|
||||
"did": 500006387,
|
||||
"pid": "43770",
|
||||
"access_pt": 4, //2-MQTT,4-LwM2M
|
||||
"data_pt": 2,
|
||||
"name": "nb4",
|
||||
"desc": "",
|
||||
"auth_info": {
|
||||
"177393918128741": "222222"
|
||||
},
|
||||
"status": 2,//0-离线;1-在线;2-未激活
|
||||
"create_time": "2022-07-13T09:19:53.873+08:00",
|
||||
"activate_time": "0001-01-01T08:00:00+08:00",
|
||||
"last_connect_time": "0001-01-01T00:00:00Z",
|
||||
"imsi": "222222",
|
||||
"imei": "177393918128741",
|
||||
"psk": "BpLnfgDsc3WD9F3q",
|
||||
"group_id": "",
|
||||
"enable_status": true,
|
||||
"Lat": "29.500816495765097",
|
||||
"Lon": "106.69984891483458",
|
||||
"auth_code": "",
|
||||
"sec_key": "TmZISzZhOTVqakprd3pEa2gwaDNmaGZVVnVTMGpaOXU=",
|
||||
"chip": 0,
|
||||
"obsv": true,
|
||||
"obsv_st": false,
|
||||
"private": false,
|
||||
"imsi_old": [],
|
||||
"imsi_mt": "0001-01-01T08:00:00+08:00",
|
||||
"intelligent_way": 1
|
||||
}],
|
||||
"limit":10,
|
||||
"offset":0
|
||||
}
|
||||
"msg": "succ",
|
||||
"requestId": "a25087f46dfddb69b29e90ef0acfd115"
|
||||
}
|
||||
Reference in New Issue
Block a user