快速对接设备告警
关注公众号
原创
HTTP协议

功能概述

本文档详细说明如何配置边缘计算盒子的数据推送功能并将其产生的告警图片、视频等数据，通过HTTP或HTTPS协议自动、实时地推送到用户指定的接收服务器（平台或应用）。 协议支持：HTTP / HTTPS（注意：不支持自定义SSL证书）。

在告警接收端创建告警接收服务

示例代码以及配置token请参考（点击此处跳转）

  • 接口功能描述：目标平台接收告警；
  • 接口路径：[POST] http(https)://IP:PORT/alert，（IP是告警接收设备的IP地址，PORT是告警接收端的端口）；
  • 上报参数说明；
参数名称 数据类型 说明
alert_time Float

告警时间戳
device Object

设备信息，包含id, name, desc
source Object

数据源信息，包含id, ipv4, desc
alg Object

算法信息，包含name, ch_name
image String

图像数据base64编码
reserved_data Object

保留数据，包含矩形框、多边形框、线条等元素
hazard_level String

危险等级
  • 报文示例；
项目 详情
报文格式

JSON
报文内容 
{
"id": "xxxxxx", //告警id
"alert_time": 1706519903.634085, //告警时间戳
    "device": {
        "id": "设备ID",
        "name": "设备名称",
        "desc": null
    },
    "source": {
        "id": "数据源ID",
        "ipv4": "数据源IP地址",
        "desc": "数据源描述"
    },
    "alg": {
        "name": "算法名称英文",
        "ch_name": "算法名称中文"
    },
    "image": "img1_base64", //base64编码的图片数据
    "hazard_level": "", //危险等级
    "reserved_data": {
        "bbox": {
            "rectangles": [{
                    "xyxy": [680, 198, 1178, 696], //左上角、右下角坐标
                    "color": [0, 0, 255], //BGR颜色
                    "conf": 0.91, //置信度
                    "label": "未佩戴安全帽", //标签
                    "ext": {} //扩展字段
                }
            ], //矩形数组
            "polygons": {    //多边形对象
                "xxxxxx": { //多边形id
                    "name": "离岗检测", //多边形名称
                    "color": [0, 0, 255], //BGR颜色
                    "polygon": [ //顶点坐标
                        [568, 205],
                        [920, 140],
                        [843, 471],
                        [576, 471]
                    ],
                    "ext": {} //扩展字段
                }
            },     
            "lines": {
                "xxxxxx": { //线段id
                    "name": "线段1", //线段名称
                    "line": [[680, 198], [1178, 696]], //顶点坐标
                    "color": [0, 0, 255], //BGR颜色
                    "ext": {} //扩展字段
                }
            }         //线段对象
        },
        "face": [{
                "external_id": "外部ID",
                "name": "姓名",
                "age": "年龄",
                "sex": "性别",
                "desc": "简介",
                "update_time": "更新时间",
                "id": "底库ID",
                "lib_image": "底库图片", //base64编码的图片数据
                "cap_image": "告警图片", //base64编码的图片数据
                "conf": "人脸相似度"
            }
        ] //人脸对象数组
    }
}

在设备页面上配置告警接收端的信息

  • 在设备界面左侧依次点击【数据推送】-【告警】-【HTTP】页签进入页面；

image.png

  • 如需打开推送，请点击【启停开关】；
  • 输入告警推送地址，即http://IP:PORT/alert；
  • （可选）点击【网络检测】可以检查url是否存在；
  • 选择告警图片是否画框，若启用表示告警图片上标记了告警的目标；若停用表示告警图片上无标记。

在告警视频接收端创建告警视频接收服务

该功能暂不适配KS968-M1&M2的32路版本，使用前务必确认产品型号。

示例代码以及配置token请参考（点击此处跳转）

  • 接口功能描述：目标平台接收告警视频；
  • 接口路径：[POST] http(https)://IP:PORT/alert/video，（IP是告警接收设备的IP地址，PORT是告警接收端的端口）；
  • 请求参数说明；
参数名称 数据类型 是否必须 说明
data Json 是 上报数据
  • data数据说明；
参数名称 数据类型 说明
alert_time Float

告警时间戳
device Object

设备信息，包含id, name , desc
source Object

数据源信息，包含id, ipv4, desc
alg Object

算法信息，包含name,ch_name
video String

告警视频数据base64编码
hazard_level String

危险等级
  • 请求示例；
项目 详情
报文格式

JSON
报文内容 
{
"id": "xxxxxx", //告警id
"alert_time": 1706519903.634085, //告警时间戳
    "device": {
        "id": "设备ID",
        "name": "设备名称"
        "desc": null
    },
    "source": {
        "id": "数据源ID",
        "ipv4": "数据源IP地址 ",
        "desc": "数据源描述"
    },
    "alg": {
        "name": "算法名称英文",
        "ch_name": "算法名称中文"
    },
    "video": "video_base64", //base64编码的视频数据
    "hazard_level": "" //危险等级
}
  • 响应参数说明；
参数名称 数据类型 是否必须 说明
error_code Int 是

返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
message String 是

返回响应信息
data Json 是

返回数据
  • 响应示例。
项目 详情
报文格式

JSON
报文内容 
{
    "error_code": 0,
    "message": "告警视频推送成功",
    "data": null
}

在设备页面上配置告警接收端的信息

  • 在设备界面左侧依次点击【数据推送】-【告警】-【HTTP】页签进入页面；

image.png

  • 如需打开推送，请点击【启停开关】；
  • 输入告警推送地址，即http://IP:PORT/alert/video；
  • （可选）点击【网络检测】可以检查url是否存在。

常见问题

点击URL检测后，系统弹出提示框显示“无效的url！”，可能的原因以及排查方法如下：

  1. 盒子未联网（通过【系统设置-高级设置】查看联网状态）
  2. 目标平台服务未启动或目标平台IP、端口填写不正确。可使用PostMan自行本地测试目标平台是否有效。
  3. 防火墙问题。需关闭目标平台防火墙。
  4. 若在局域网测试，则可能盒子IP和目标平台不在同一网段，即盒子到目标平台不可达。并自行排查网络问题。
  5. 自建平台状态码没有返回200，不影响使用。

示例JSON

示例JSON

真诚点赞 诚不我欺

热门评论

有魅力的篮球 2025年11月27日 14:56
在告***接收端创建告***接收服务 ------------------------------------------------------ 文档里说明数据类型是json，在json中有video字段，video是base**的字符串。 但是使用你们的远程测试环境，实际测试发现，**数据推送过来时，数据类型是multipart/form-data， 这是为啥
点赞
回复1 取消回复
有魅力的篮球 2025年11月27日 14:57
我用的是github里的java版示例代码，报错日志： w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'multipart/form-data;boundary=8467ae9003c1a179ce4f54d9e33867ac;charset=UTF-8' not supported]
点赞
回复 取消回复

2 条评论

有魅力的篮球 2025年11月27日 15:23
经过调试，我发现，接*这样定义，才能正确接收到**数据，还请**者帮忙**，是该以文档为准，还是以远程测试环境为准 public String notify( @RequestParam(name = "data", required = false) String data, @RequestParam(name = "video", required = false) MultipartFile[] video) { }
点赞
回复 取消回复
有魅力的篮球 2025年11月27日 14:56
在告***接收端创建告***接收服务 ------------------------------------------------------ 文档里说明数据类型是json，在json中有video字段，video是base**的字符串。 但是使用你们的远程测试环境，实际测试发现，**数据推送过来时，数据类型是multipart/form-data， 这是为啥
点赞
回复1 取消回复
有魅力的篮球 2025年11月27日 14:57
我用的是github里的java版示例代码，报错日志： w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'multipart/form-data;boundary=8467ae9003c1a179ce4f54d9e33867ac;charset=UTF-8' not supported]
点赞
回复 取消回复

HTTP协议