Quellcode durchsuchen

修改报警匹配条件接口说明

lixing vor 4 Jahren
Ursprung
Commit
039db7bdcb
2 geänderte Dateien mit 80 neuen und 20 gelöschten Zeilen
  1. 73 20
      docs/alarm/alarm_api.md
  2. 7 0
      docs/alarm/alarm_dict.md

+ 73 - 20
docs/alarm/alarm_api.md

@@ -3,8 +3,9 @@
 ## 系统接口
 
 >
->  注:userId、groupCode、projectId必须传值,appId可以为空)
->
+> 注:userId、groupCode、projectId必须传值,appId可以为空)
+> 除报警条目查询外,groupCode = 0 代表查询所有集团的数据,projectId = 0 代表查询所有项目的数据,appId = 0 代表查询所有子系统的数据
+> 
 > 请求方法:POST
 >
 > **重要:除特殊说明外,本文档中所有的查询接口入参,请参照[通用查询](/utils/query.md)格式,本文档的查询入参只包含通用查询的criteria部分**
@@ -36,7 +37,9 @@
 
 请求路径:/alarm/item/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
-(注:condition 为 query)
+> groupCode = 0 代表查询通用的报警条目
+> groupCode = 集团编码 查询的是(集团私有 + 通用)的报警条目
+> projectId,appId = 0的查询规则与groupCode相同
 
 #### query
 请求参数:
@@ -106,44 +109,94 @@
 
 请求路径:/alarm/target/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
-(注:condition 为 query,create,update,delete)
-
+#### query
 请求参数:
 
-```json
-查询字段:
+```json5
 {
   "id": "1",
-  "itemCode": "1033", 
-  "classCode": "OBJ_AX_CODE",
-  "concern": 1,
-  "open": 2,
+  "itemCode": "1033",   // 报警条目编码
+  "classCode": "OBJ_AX_CODE",   // 对象类型编码
+  "concern": 1,   // 是否重点关注(敏感度),参考敏感度字典
+  "open": 1,  // 屏蔽状态(0:屏蔽,1:不屏蔽)
+  "level": "1",   // 报警等级,参照报警等级字典
   "createUser": "test",
   "createTime": 1602963135000,
   "updateUser": "test",
   "updateTime": 1602963138000,
-  "valid": 1
 }
-新增:
+```
+
+返回值:
+
+```json
+{
+  "result": "success",
+  "data": [
+    {
+      "id": "01ec6dd9-73a9-4bf0-ab14-35c2d99089bc",
+      "itemCode": "1005",
+      "classCode": "ACCC",
+      "condition": {
+        "end": "onlineStatus>0.5",
+        "time": {
+          "type": "period",
+          "period": {
+            "$gt": "090000",
+            "$lt": "210000"
+          }
+        },
+        "trigger": "onlineStatus<0.5",
+        "infoCode": [
+          "onlineStatus"
+        ],
+        "endUphold": 0,
+        "triggerUphold": 0
+      },
+      "concern": 0,
+      "level": "S",
+      "open": 0,
+      "createUser": "System",
+      "createTime": 1604890777000,
+      "valid": 1,
+      "projectId": "Pj1101050029",
+      "groupCode": "WD"
+    }
+  ],
+  "count": 120
+}
+```
+
+#### create
+请求参数:
+
+```json
 {
   "itemCode": "1033",
   "classCode": "OBJ_AX_CODE",
   "concern": 1,
-  "open": 2,
-  "condition": {}, //额外写文档
-  "valid": 1
+  "open": 1,
+  "condition": {}
 }
-更新:
+```
+
+#### update
+请求参数:
+
+```json
 {
   "id": "1",
   "itemCode": "1033",
   "classCode": "OBJ_AX_CODE",
   "concern": 1,
   "open": 2,
-  "condition": {}, //额外写文档
-  "valid": 1
+  "condition": {}
 }
-删除:
+```
+#### delete
+请求参数:
+
+```json
 {
   "id": "1"
 }

+ 7 - 0
docs/alarm/alarm_dict.md

@@ -28,6 +28,13 @@ public enum EnumAlarmCategory {
 }
 ```
 
+## 敏感度(alarm_concern)
+|编码|名称|
+|----|----|
+|0|高|
+|1|中|
+|2|低|
+
 ## 报警等级 (alarm_level)
 
 ```java