Bladeren bron

完善报警接口

lixing 4 jaren geleden
bovenliggende
commit
8798b7aa55
1 gewijzigde bestanden met toevoegingen van 10 en 4 verwijderingen
  1. 10 4
      docs/alarm/alarm_api.md

+ 10 - 4
docs/alarm/alarm_api.md

@@ -7,9 +7,12 @@
 >
 > 请求方法:POST
 >
-> **重要:除特殊说明外,本文档中所有的接口入参,请参照[通用查询](/utils/query.md)格式,本文档的入参只包含通用查询的criteria部分**
+> **重要:除特殊说明外,本文档中所有的查询接口入参,请参照[通用查询](/utils/query.md)格式,本文档的查询入参只包含通用查询的criteria部分**
 
 ### 报警条件
+
+约定格式:
+
 ```json5
 { 
   "configs": {  // 用户页面的配置信息
@@ -33,10 +36,13 @@
 }
 ```
 
-### 查询报警条目
+### 报警条目
+
+请求路径:/alarm/item/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
-请求路径:/alarm/item/query?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+(注:condition 为 query)
 
+#### query
 请求参数:
 
 ```json5
@@ -178,7 +184,7 @@
 }
 ```
 
-查询返回值
+返回值
 
 ```json5
 {