国标接入网关
    国标接入网关
    • 接口说明
    • 视频接入网关
      • 对外接口
        • 流控制
          • 实时视频推流
          • 实时视频停止推流
          • 录像推流
          • 停止录像/下载推流
          • 录像下载
          • 录像控制
          • 语音对讲
          • 语音对讲停止
        • 设备控制
          • A.2.3.1.2 摄像机云台控制(A.3.2 PTZ指令/A.3.3 FI指令/A.3.7 辅助开关控制指令)
          • A.2.3.1.2 摄像机云台控制(A.3.4 预置位指令)
          • A.2.3.1.2 摄像机云台控制(A.3.5 巡航指令)
          • A.2.3.1.2 摄像机云台控制(A.3.6 扫描指令)
          • A.2.3.1.2 摄像机云台控制(级联)
          • A.2.3.1.3 远程启动控制
          • A.2.3.1.4 录像控制命令
          • A.2.3.1.5 报警布防/撤防控制命令
          • A.2.3.1.6 报警复位控制命令
          • A.2.3.1.7 强制关键帧控制命令
          • A.2.3.1.8 拉框放大控制命令
          • A.2.3.1.9 拉框缩小控制命令
          • A.2.3.1.10 看守位控制命令
          • A.2.3.1.11 PTZ精准控制控制命令
          • A.2.3.1.12 设备软件升级控制命令
          • A.2.3.1.13 存储卡格式化控制命令
          • A.2.3.1.14 目标跟踪控制命令
          • GB35114 设备签名控制
          • GB35114 设备加密控制
          • 接入密码修改(定制终端)
          • 运行日志上传(定制终端)
        • 设备配置
          • A.2.3.2.2 基本参数配置
          • A.2.3.2.3 SVAC 编码配置
          • A.2.3.2.4 SVAC 解码配置
          • A.2.3.2.5 视频参数属性配置
          • A.2.3.2.6 录像计划配置
          • A.2.3.2.7 报警录像配置
          • A.2.3.2.8 视频画面遮挡配置
          • A.2.3.2.9 画面翻转配置
          • A.2.3.2.10 报警上报开关配置
          • A.2.3.2.11 前端OSD配置
          • A.2.3.2.12 图像抓拍配置
          • A.2.4.7 基本参数查询配置
          • A.2.4.7 视频参数范围查询
          • A.2.4.7 SVAC解码查询
          • A.2.4.7 SVAC编码查询
          • A.2.4.7 视频参数属性查询
          • A.2.4.7 录像计划查询
          • A.2.4.7 报警录像查询
          • A.2.4.7 视频画面遮挡查询
          • A.2.4.7 画面翻转查询
          • A.2.4.7 报警上报开关查询
          • A.2.4.7 前端OSD设置查询
          • A.2.4.7 图像抓拍配置查询
          • 设备网络参数配置(定制终端)
          • 断网续存配置(定制终端)
          • 设备网络参数配置查询(定制终端)
          • 断网续存配置查询(定制终端)
        • 设备查询
          • A.2.4.2 设备状态查询
          • A.2.4.3 设备目录信息查询或订阅请求(缓存)
          • A.2.4.3 设备目录信息查询或订阅请求(同步)
          • 目录查询状态查询接口
          • A.2.4.4 设备信息查询请求
          • A.2.4.5 文件目录检索请求
          • A.2.4.8 设备预置位查询 (A.2.6.10 设备预置位查询应答)
          • A.2.4.10 看守位信息查询 (A.2.6.12 看守位信息查询应答)
          • A.2.4.11 巡航轨迹列表查询 (A.2.6.13 巡航轨迹列表查询应答)
          • A.2.4.12 巡航轨迹查询 (A.2.6.14 巡航轨迹查询应答)
          • A.2.4.13 PTZ精准状态查询或订阅(A.2.6.15)
          • A.2.4.14 存储卡状态查询 (A.2.6.16)
          • 设备在线状态查询接口
          • 设备状态查询接口 (定制终端)
        • 订阅
          • 事件订阅
          • 事件退订
          • 事件查询
          • 订阅刷新
        • 动火项目
          • 增加人员
          • 删除人员
          • 算法开关
          • 算法区域
          • 人员查询
          • 算法查询
          • 算法状态查询
          • 算法区域查询
        • 查看微服务版本
        • 清理设备信息缓存
      • 依赖接口
        • 服务状态保活
          • 网关服务心跳
          • 网关服务注册
        • 信息查询
          • 平台注册信息查询
          • 设备注册信息查询(包含重定向)
        • 事件通知
          • 设备状态变更通知
          • 设备目录变更通知
          • 设备报警通知
        • 事务状态通知
          • 设备主动断流
          • 录像播放结束
          • 设备升级成功
          • 日志上传

    接口说明

    NOTE#

    国标接入网关暂时不处理中文编码,接口中涉及中文的字段需要提供GB18030编码的base64编码格式,国标接入网关返回的也是GB18030编码的base64编码格式

    接口返回#

    HTTP 返回码#

    200 OK 请求处理正常
    400 Bad Request 请求参数类型不符合要求
    404 Not Found 接口不存在或接口调用失败(有歧义,后续可能会修改),需要解析body部分
    body code = 103 接口不存在
    body code != 103 接口调用失败
    408 Time out 请求接口处理超时
    500 Internal Server Error 网关内部错误

    错误码#

    10041001 无效参数
    10041002 设备离线
    10041003 请求超时
    10041004 用户停止该请求
    10041101 设备拒绝
    10041102 设备错误
    10041103 设备响应错误
    10041104 等待设备响应中
    10042201 内部错误
    10042202 会话不存在
    10042203 会话已经存在
    10042204 稍后再试
    10042205 请求发送失败

    KafKa 数据格式#

    设备上下线#

    topic:PAG-DEVSTATUS
    定义
    message PuOnlineStateRequest {
      message PuOnlineState {
            optional string deviceId = 1;
            optional int32  state    = 2;
            optional string ipAddress = 3;
        }
    
        repeated PuOnlineState puStateList = 1;
        optional string        pagDeviceId = 2;
        optional uint64        timestamp = 3;
        optional int32         reason = 4; // 1: 管理员操作 2: 注销 3: 超时 4: 断流失败
    }
    实例
    {"puStateList":[{"deviceId":"42020101001320000001","state":1,"ipAddress":"127.0.0.1"}],"pagDeviceId":"127.0.0.1","time
    stamp":"1715148225369"}
    {"puStateList":[{"deviceId":"42020101001320000001"}],"pagDeviceId":"127.0.0.1","timestamp":"1715148301175","reason":1}

    目录订阅#

    topic:PAG-DEVSUBSCRIBE
    定义
    实例

    设备告警#

    topic: PAG-EVENTS
    定义
    实例
    电话报警 110000
    设备报警 120000
      - 视频丢失 120010
      - 设备防拆 120020
      - 存储设备磁盘满 120030
      - 设备高温 120040
      - 设备低温 120050
    短信报警 130000
    GPS报警 140000
    视频报警 150000
      - 人工视频 150010
      - 运动目标检测 150020
      - 遗留物检测 150030
      - 物体移除检测 150040
      - 绊线检测 150050
      - 入侵检测 150060
        - 入侵检测 进入 150061
        - 入侵检测 离开 150062
      - 逆行检测 150070
      - 徘徊检测 150080
      - 流量统计 150090
      - 密度检测 150100
      - 视频异常检测 150110
      - 快速移动 150120
      - 图像遮挡 150130
    设备故障报警 16000
      - 存储设备磁盘故障 160010
      - 存储设备风扇故障 160020
    其他报警 170000

    移动位置#

    topic:PAG-MOBILEPOSITION
    定义
    message KafkaNotifyMobilePositionRequest {
        message ItemType {
            optional string deviceId = 1;
            optional string captureTime = 2;
            optional double longitude = 3;
            optional double latitude = 4;
            optional double speed = 5;
            optional double direction = 6;
            optional double altitude = 7;
            optional double height = 8;
        }
    
        optional string sourceId = 1;
        optional string eventTime = 2;
        repeated ItemType items = 3;
    }
    实例
    {"sourceId":"42020000001320026462","eventTime":"1724842322000","items":[{"deviceId":"42020000001320026462","captureTime":"1724842322000","longitude":100.508331,"latitude":10.838889,"speed":0,"direction":0,"altitude":0}]}

    PTZ精确位置#

    topic:PAG-PTZPOSITION
    定义
    message KafkaNotifyPtzPoistionRequest {
        optional string deviceId = 1;
        optional double pan = 2;
        optional double tilt = 3;
        optional double zoom = 4;
        optional double horizontal = 5;
        optional double vertical = 6;
        optional double distance = 7;
        optional string timestamp = 8;
    }
    实例
    {"deviceId":"42020101001320000001","pan":1.111111,"tilt":2.222222,"zoom":3.333333,"horizontal":4.444444,"vertical":5.555556,"distance":6.666667,"timestamp":"1715148301175"}

    GBT28181-2022 抓拍上传通知#

    topic:PAG-SNAPSHOT
    定义
    message KafkaNotifyUploadSnapShotFinished {
        optional string deviceId = 1;
        optional string sessionId = 2;
        optional string timestamp = 3;
        repeated string ids = 4;
    }
    实例
    {"deviceId":"42020101001320000001","sessionId":"XXX","timestamp":"1715148301175","ids":["111":,"222"]}
    下一页
    实时视频推流
    Built with