对接设备全部接口
关注公众号
原创
告警管理

1. 查询告警

参数名称数据类型是否必须说明
pageInt是页码
sizeInt是每页数量
source_descString否数据源
alg_ch_nameString否算法名称
hazard_levelString否危险等级
statusInt否告警状态
start_timeInt否开始时间秒数
end_timeInt否结束时间秒数

表. 请求参数

  • 请求示例；
项目详情
请求格式Query String
page1
size10
  • 响应参数说明；
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
messageString返回响应信息
dataObject返回数据
  • 响应示例。
项目详情
报文格式JSON
报文内容{
  "data": {
        "data": [],
        "total": 0
  },
  "error_code": 0,
  "message": {
        "zh": "查询告警成功！",
        "en": "Query alert successful!"
    }
}

2. 修改告警

参数名称数据类型是否必须说明
conditionObject是{
    "alert_ids":告警id列表（可选，若存在此参数则忽略其它参数），
    "source_desc": 数据源（String，可选）,
    "alg_ch_name": 算法名称（String，可选）,
    "hazard_level": 危险等级（String，可选）,
    "status": 告警状态（Int，可选）,
    "start_time": 开始时间秒数（Int，可选）,
    "end_time": 结束时间秒数（Int，可选）
}
statusInt否告警状态。1：未处理，2：确认，3：销警
descObject否告警描述，用具记录告警的处理人、处理时间、处理意见等信息

表. 请求参数

  • 请求示例；
项目详情
请求格式JSON
报文内容{
    "condition": {
        "alert_ids": ["667d02375dc58a0ac4bc439f"]
    },
"status": 1，
"desc": [{"time": "2024-10-31 11:21:42", "name": "王总", "opinion": "同意"}]
}
  • 响应参数说明；
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
messageString返回响应信息
dataNull/Objectnull
  • 响应示例。
项目详情
报文格式JSON
报文内容{
"data": null,
"error_code": 0,
       "message":
        "zh": "更新告警成功！",
        "en": "Update alert successful!"
    }
}

3. 删除告警

参数名称数据类型是否必须说明
conditionObject是{
    "alert_ids":告警id列表（可选，若存在此参数则忽略其他参数），
    "source_desc": 数据源（String，可选）,
    "alg_ch_name": 算法名称（String，可选）,
    "hazard_level": 危险等级（String，可选）,
    "status": 告警状态（Int，可选）,
    "start_time": 开始时间秒数（Int，可选）,
    "end_time": 结束时间秒数（Int，可选）
}

表. 请求参数

  • 请求示例；
项目详情
请求格式JSON
报文内容{
    "condition": {
        "alert_ids": ["667d02375dc58a0ac4bc439f"]
}
}
  • 响应参数说明；
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
messageString返回响应信息
dataNull/Objectnull
  • 响应示例。
项目详情
报文格式JSON
报文内容{
"data": null,
"error_code": 0,
       "message":
        "zh": "删除告警成功！",
        "en": "Delete alert successful!"
    }
}

4. 导出告警

参数名称数据类型是否必须说明
alert_idsList否告警id列表，若存在此参数，则忽略其他参数
source_descString否数据源
alg_ch_nameString否算法名称
hazard_levelString否危险等级
statusInt否告警状态
start_timeInt否开始时间秒数
end_timeInt否结束时间秒数

表. 请求参数

  • 请求示例；
项目详情
请求格式Query String
alert_ids["667d02375dc58a0ac4bc439f"]

注意：前端调用时，还需指定responseType:'blob'。

  • 响应参数说明；
参数名称数据类型说明
dataString文件流
  • 响应示例。
项目详情
报文格式文件流
报文内容略

5. 根据告警id查询告警

参数名称数据类型是否必须说明
alert_idString是告警id

表. 请求参数

  • 请求示例；
  项目详情
请求格式Query String
alert_id667d02375dc58a0ac4bc439f
  • 响应参数说明；
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
messageString返回响应信息
dataObject返回数据
  • 响应示例。
项目详情
报文格式JSON
报文内容{
    "error_code": 0,
    "message": {
        "zh": "查询告警成功！",
        "en": "Query alert successful!"
    },
    "data": {…}
}

真诚点赞 诚不我欺

告警管理