告警管理-智驱力

1. 查询告警

接口功能描述：查询告警结果；
接口路径：[GET] http://设备IP:9091/ks/alert；
请求参数说明；

参数名称	数据类型	是否必须	说明
page	Int	是	页码
size	Int	是	每页数量
source_desc	String	否	数据源
alg_ch_name	String	否	算法名称
hazard_level	String	否	危险等级
status	Int	否	告警状态
start_time	Int	否	开始时间秒数
end_time	Int	否	结束时间秒数

表. 请求参数

请求示例；

项目	详情
请求格式	Query String
page	1
size	10

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	返回数据

响应示例。

项目

详情

报文格式

JSON

报文内容

{
    "data": {
        "data": [
         "id": "告警id",
        "alert_time": 1743561648,
        "source_id": "6784e22c5dc58ad87f124e96",
        "source_ipv4": "192.168.0.9",
        "source_desc": "40",
        "alg_name": "helmet",
        "alg_ch_name": "未佩戴安全帽检测",
        "hazard_level": "",
        // 访问路径：http://IP:9092/staticdata/image路径
        "image": "/home/xxx/alert.jpg", 
        "reserved_data": "{}",
        // 访问路径：http://IP:9092/staticdata/video路径
        "video": "/home/xxx/video.mp4",
        "status": 1,
        "desc": "[]"
        ],
        "total": 0
    },
    "error_code": 0,
    "message": {
        "zh": "查询告警成功！",
        "en": "Query alert successful!"
    }
}

2. 修改告警

接口功能描述：修改告警结果（告警确认）；
接口路径：[PUT] http://设备IP:9091/ks/alert；
请求参数说明；

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

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "condition": { "alert_ids": ["667d02375dc58a0ac4bc439f"] }, "status": 1， "desc": [{"time": "2024-10-31 11:21:42", "name": "王总", "opinion": "同意"}] }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": "zh": "更新告警成功！", "en": "Update alert successful!" } }

3. 删除告警

接口功能描述：删除告警结果；(注：若不传参，则默认删除所有告警)
接口路径：[DELETE] http://设备IP:9091/ks/alert；
请求参数说明；

参数名称	数据类型	是否必须	说明
condition	Object	是	{ "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_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": "zh": "删除告警成功！", "en": "Delete alert successful!" } }

4. 导出告警

接口功能描述：导出告警结果，调用时需要注意单次导出不超过1000条；
接口路径：[GET] http://设备IP:9091/ks/alert/xlsx；
请求参数说明；

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

表. 请求参数

请求示例；

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

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

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

5. 根据告警id查询告警

接口功能描述：根据告警id查询告警结果；
接口路径：[GET] http://设备IP:9091/ks/alert/by\_id；
请求参数说明；

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

表. 请求参数

请求示例；

项目	详情
请求格式	Query String
alert_id	667d02375dc58a0ac4bc439f

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Object	返回数据

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "error_code": 0, "message": { "zh": "查询告警成功！", "en": "Query alert successful!" }, "data": {…} }

1. 查询告警

2. 修改告警

3. 删除告警

4. 导出告警

5. 根据告警id查询告警

相关推荐

告警管理