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

1. 业务场景

1.1. 告警记录

1.1.png

1.1.1. 查询告警记录

接口调用顺序：2.1

1.1.2. 更新告警记录

接口调用顺序：2.2

1.1.3. 删除告警记录

接口调用顺序：2.3

1.1.4. 导出告警记录

接口调用顺序：2.4

1.1.5. 告警详情

接口调用顺序：2.1 -> 2.5
说明：
2.1：获取告警ID
2.5：根据告警ID获取告警详情

1.2. 跨线计数

1.2.png

1.2.1 查询跨线计数统计信息

接口调用顺序：2.6

1.2.2 手动清零

接口调用顺序：2.7

1.2.3 设置清零策略

接口调用顺序：2.7

2. 原子告警

2.1. 查询告警

  • 接口功能描述：查询告警结果；
  • 接口路径：[GET] http://盒子IP:9091/ks/alert；
  • 请求参数说明；
参数名称数据类型是否必须说明
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": [
         "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.2. 修改告警

  • 接口功能描述：修改告警结果（告警确认）；
  • 接口路径：[PUT] http://盒子IP:9091/ks/alert；
  • 请求参数说明；
参数名称数据类型是否必须说明
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!"
    }
}

2.3. 删除告警

  • 接口功能描述：删除告警结果；(注：若不传参，则默认删除所有告警)
  • 接口路径：[DELETE] http://盒子IP:9091/ks/alert；
  • 请求参数说明；
参数名称数据类型是否必须说明
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!"
    }
}

2.4. 导出告警

  • 接口功能描述：导出告警结果，调用时需要注意单次导出不超过1000条；
  • 接口路径：[GET] http://盒子IP:9091/ks/alert/xlsx；
  • 请求参数说明；
参数名称数据类型是否必须说明
alert_idsList否告警id列表，若存在此参数，则忽略其他参数
source_descString否数据源
alg_ch_nameString否算法名称
hazard_levelString否危险等级
statusInt否告警状态
start_timeInt否开始时间秒数
end_timeInt否结束时间秒数

表. 请求参数

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

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

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

2.5. 根据告警id查询告警

  • 接口功能描述：根据告警id查询告警结果；
  • 接口路径：[GET] http://盒子IP:9091/ks/alert/by_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": {…}
}

2.6. 查询跨线计数信息

  • 接口功能描述：跨线计数信息查询；
  • 接口路径：[GET] http://盒子IP:9091/ks/cross_line_counting；
  • 请求参数说明；
参数名称数据类型是否必须说明
pageInt是页码
sizeInt是每页数量
source_descString否数据源
alg_ch_nameString否算法名称
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 cross_line_counting successful!"
}
}

2.7. 跨线计数清零

  • 接口功能描述：跨线计数清零；
  • 接口路径：[PUT] http://盒子IP:9191/ks/cross_line_counting
  • 请求参数说明；
参数名称 数据类型 是否必须 说明
id string 是 跨线计数id
strategy Object 否
{ "enable": true, // 是否开启策略清零 "strategy": "every_week", // every_week：每周；every_day：每天 "day_of_week": 4, // 周四，strategy为every_week有效 "time_of_day": "00:23:00", // 清零时间 }
result Bool 否 true代表手动清零，不传或false表示策略模式清零

表. 请求参数

  • 请求示例；
项目 详情
请求格式 JSON
报文内容 
{
  "id": "line_ff4c3448-6884-45a1-bb3a-cc5c91fd6632",
  "strategy": {
    "enable": true,
    "strategy": "every_week",
    "day_of_week": 3,
    "time_of_day": "00:23:00",
    "last_time": 0
  },
  "result": false
}
  • 响应参数说明；
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
messageString返回响应信息
dataNull/Object批量更新时，将以对象形式返回每个设备是否成功
  • 响应示例。
项目详情
报文格式JSON
报文内容{
"data": null,
"error_code": 0,
"message":
"zh": "更新跨线计数统计成功！",
"en": "Update cross_line_counting successful!"
}
}

真诚点赞 诚不我欺

告警记录