文档更新

docs/_sidebar.md

@@ -7,6 +7,7 @@
   -	[数据字段接口](api/enumPage.md)
   -	[人工操作接口](api/operation.md)
   - [页面访问接口](api/pages/)
+  - [告警事件接口](api/event.md)
     - [首页接口](api/pages/home.md)
 - [数据采集](datacollect/)
 - [系统部署](deploy/)

docs/api/event.md

@@ -0,0 +1,118 @@
+# 告警相关模块
+
+## API接口一览表
+
+| 接口分类    | 接口描述            | API接口                               | 权限                         |
+|---------|-----------------| ------------------------------------- | --------------------------- |
+| 1.1告警相关操作 | 1.1.1查询设备告警信息列表 | /api/event/query | |
+|  | 1.2.1确认告警信息 | /api/event/confirm |  |
+|         |   |                    |  |
+
+
+### 1.1 告警相关操作接口
+
+#### 1.1.1查询设备告警信息列表
+
+POST 请求接口
+
+> /api/event/query
+
+请求参数
+
+```json
+{
+    "startTime":1730778600161,
+    "endTime":1730779105676,
+    "eventLevel": 0,
+    "deviceCode":["A-001"],
+    "pageNum": 1,
+    "pageSize": 10
+}
+```
+入参描述
+
+| 参数名       | 参数类型    | 必填 | 描述     |
+| ------------ |---------|-----|--------|
+| startTime   | Long | True | 开始时间   |
+| endTime | Long | True | 结束时间   |
+| eventLevel | int | False | 事件等级0：告警，1：故障 |
+| deviceCode | List  | True | 设备编码数组             |
+| pageNum | Integer | NO  | 当前页    |
+| pageSize | Integer  | NO | 每页显示大小 |
+
+返回报文
+
+```json
+{
+    "total": 10501,
+    "rows": [
+        {
+            "eventTime": 1730778601000,
+            "eventId": "1853647068678127617",
+            "eventType": 0,
+            "eventLevel": 0,
+            "eventText": "风机由于变桨系统安全链断开导致机组急停 动作",
+            "confirmed": 1,
+            "confirmAccount": "null",
+            "confirmTime": 1730789465314,
+            "deviceId": "1846101273013739522",
+            "deviceCode": "A-001"
+        },
+        {
+            "eventTime": 1730778601000,
+            "eventId": "1853647068678127618",
+            "eventType": 0,
+            "eventLevel": 0,
+            "eventText": "风机轮毂温度>60℃ 复归",
+            "confirmed": 0,
+            "confirmTime": 0,
+            "deviceId": "1846101273013739522",
+            "deviceCode": "A-001"
+        }
+    ],
+    "code": 200,
+    "msg": "查询成功"
+}
+```
+
+
+
+
+#### 1.1.2 确认告警信息
+
+POST 请求接口
+
+> /api/event/confirm
+
+请求参数
+
+```json
+[
+    {
+    "eventTime": 1730778601000,
+    "eventId": "1853647068678127617",
+    "confirmed": 1,
+    "deviceId": "1846101273013739522"
+    }
+]
+```
+入参描述
+
+| 参数名       | 参数类型    | 必填  | 描述   |
+| ------------ |---------|-----|------|
+| eventTime | Long    | true | 事件时间                 |
+| eventId | String  | true | 事件id |
+| confirmed | int  | true | 是否确认：0不确认，1确认 |
+| deviceId | String  | true | 设备id |
+
+返回报文
+
+```json
+{
+  "code": 200,
+  "success": true,
+  "msg": "操作成功"
+}
+```
+
+