docs: add OneNET API reference documentation

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-06-03 11:11:09 +08:00
parent 69e13f504f
commit 0845c38b72
10 changed files with 840 additions and 0 deletions
@@ -0,0 +1,71 @@
+设备事件记录查询
+最近更新时间：2025-07-02 10:27:26
+接口说明
+查询设备的事件记录
+
+接口地址
+https://iot-api.heclouds.com/device/event-log
+
+API说明
+请求方式：GET
+
+http query 请求参数：
+
+参数名称	格式	是否必选	说明
+product_id	string	产品id+设备名称、imei二选一必填	产品ID
+device_name	string	产品id+设备名称、imei二选一必填	设备名称
+imei	string	产品id+设备名称、imei二选一必填	设备imei (当设备来自于老平台下NB套件产品时，imei必填，且device_name应当为空)
+start_time	long	是	查询起始时间-毫秒时间戳
+end_time	long	是	查询截止时间-毫秒时间戳
+identifier	string	否	事件功能点标识
+event_type	int	否	事件类型，1-信息，2-告警，3-故障
+offset	int	否	请求起始位置，默认0
+limit	int	否	每次请求记录数，默认10，范围[1,100]
+返回数据
+
+参数名称	类型	描述
+code	int	错误码，当为0时表示请求成功，取值见错误码说明表
+msg	string	错误描述信息
+request_id	string	API请求链路id
+data	-	具体响应内容
+data.list	Object-array	设备事件记录列表
+data.list[0].event_type	int	事件类型，1-信息，2-告警，3-故障
+data.list[0].time	long	设备事件上报时间戳
+data.list[0].identifier	string	事件功能点标识
+data.list[0].name	string	事件名称
+data.list[0].value	string	事件值
+data.limit	string	本次请求记录数上限
+data.offset	string	本次请求起始位置
+示例
+请求示例：
+
+GET https://iot-api.heclouds.com/device/event-log?
+imei=1234512345&start_time=1592398420000&end_time=1592398421297
+
+响应示例：
+
+{
+    "code": 0,
+    "data": {
+       "list": [
+		   {
+                "event_type": 1,
+                "identifier": "lock_event",
+                "name": "lock_event",
+                "time": 1592814341051,
+                "value": "{\"type\":1, \"user\":27010}"
+            },
+            {
+                "event_type": 1,
+                "identifier": "lock_event",
+                "name": "lock_event",
+                "time": 1592814336050,
+                "value": "{\"type\":2, \"user\":27010}"
+            }
+	    ],
+        "limit": 10,
+        "offset": 0
+    },
+    "msg": "succ",
+    "request_id": "a25ffffddsfddb69b29e90ef0acfd115"
+}