1、 ICS 35.240 CCS L 77 3502 福建省厦门市地方标准 DB3502/T 072.2 2021 公共安全 视频图像 系统运维 技术规范 第2 部分:接口 Technical specification for operation and maintenance of video and image system for public securityPart2:Interfaces 2021-12-21 发布 2022-01-03 实施 厦门市市 场监督 管 理局 发 布 DB3502/T 072.2 2021 I 目 次 前言.II 引言.III 1 范围.1 2 规 范性
2、 引用 文件.1 3 术 语和 定义.1 4 缩 略语.1 5 接 口分 类与 协议 结构.1 6 接 口功 能.2 7 接 口资 源描 述.3 8 接口.3 附录A(资 料性)REST 架构协 议模 型.39 附录B(资 料性)告警.42 附录C(资 料性)资源URI.44 DB3502/T 072.2 2021 II 前 言 本文件 按照GB/T 1.1 2020 标 准化 工作 导则 第1 部分:标准 化文 件的 结构 和起草 规则 的 规 定起草。本文件 为DB3502/T 072 公共安 全视 频图 像 系 统运 维技术 规范 的 第2 部分。DB3502/T 072 已发 布了以下
3、 部分:第1 部 分:总体 要求;第2 部 分:接口;第3 部 分:数据 元。请注意 本文 件的 某些 内容 可能涉 及专 利。本文 件的 发布机 构不 承担 识别 专利 的责任。本文件 由厦 门市 安全 技术 防范协 会提 出。本文件 由厦 门市 公安 局归 口。本文件 起草 单位:厦 门市 公安局、厦 门市 安全 技术 防范协 会、厦门 市标 准化 研究院、苏 州科 达科 技股份有 限公 司、厦 门凯 迪 空间电 子有 限公 司、杭 州 海康威 视数 字技 术股 份有 限公司、罗普 特科 技集 团 股份有限 公司。本文件 主要起 草人:李童、覃智 泉、林 三达、张茂 林、庄 毅滨、郭流 流
4、、陆 通、柳 少英、崔晓 琳、李钊茜、夏 莉、李庚、陈 耿斌。DB3502/T 072.2 2021 III 引 言 公共安 全视 频图 像系 统在 打击犯 罪、治 安防 控、社 会 治理以 及服 务民 生方 面发 挥了重 要的 作用,公共 安 全视 频 图像 系 统运 维管 理 平台 建 设的 统 一和 规范,将进 一 步提 升 公共 安全 视 频图 像 系统 运 维的服务水平,有利 于视 频图 像 行业的 专业 化、规 范化 发 展。DB3502/T 072 公 共 安全视 频图 像系 统运 维技 术规范 旨在 确立 公共 安全 视频图 像系 统运 维管 理平 台总体 设计、接 口、数据
5、元的技 术标 准,为视 频 图 像系统运 维管 理平 台的 建设 提供基 础规 范。DB3502/T 072 拟 由三 个部 分构成:第1 部 分:总体 要求。目 的在于 确立 公共 安全 视频 图像系 统运 维管 理平 台关 键技术 路线 和软件系统 的组 织形 式,确保 总体架 构满 足服 务范 围内 公共安 全视 频图 像系 统运 维需求,明 确主要功能 模块 和模 块间 的逻 辑关系,避 免“过度 建设”并确 保“必要 建设”。第2 部 分:接口。目 的在 于将公 共安 全视 频图 像系 统运维 管理 平台 对外 接口 标准化,明 确接口在安 全性、完 备性、一 致性、易用 性、稳定
6、性方 面的要 求,并从 本级 一机 一档管 理系 统、下级公 共安 全视 频图 像系 统运维 管理 平台、前 端智 能箱系 统及 其他 应用 系统 接入等 方面,明确接入 的实 现方 式,为保 障建设 质量 及拓 展应 用范 围提供 技术 支撑。第3 部 分:数据 元。通过 标准化 描述 公共 安全 视频 图像系 统运 维管 理平 台的 数据元 和数 据模型,构 建标 准化 的数 据环 境,为 建设 数据 共享、标 准统一 的公 共安 全视 频图 像运维 管理 体系提供基 础规 范。DB3502/T 072.2 2021 1 公共安全 视频图 像系统运 维技术 规范 第2 部分:接口 1 范围
7、 本文件 规定 了 公 共安 全视 频图像 系统 运维 管理 平台 的接口 分类 与协 议结 构、接口功 能、接口 资源 描述、接 口等 技术 要求。本 文 件 适用 于 公共 安 全视频 图 像 系统 运 维管 理 平台的 规 划 设计、软件 开 发及接 口 协 议的 符 合性 测试。2 规范性 引用 文件 下列文 件中 的内 容通 过文 中的规 范性 引用 而构 成本 文件必 不可 少的 条款。其 中,注日 期的 引用 文件,仅该日 期对 应的 版本 适用 于本文 件;不注 日期 的引 用文件,其 最新 版本(包 括所有 的修 改单)适 用 于 本文件。GB/T 28181 公 共安 全视
8、 频 监控联 网系 统信息 传 输、交换、控制 技术 要求 GA/T 1400.4 公 安视 频图 像信息 应用 系统 第4 部分:接口 协议 要求 DB3502/T 072.1 公 共安 全 视频图 像 系 统运 维技 术规 范 第1 部分:总 体要 求 IETF RFC 2616 超文 本传 输协议-HTTP/1.1(Hypertext Transfer Protocol-HTTP/1.1)3 术语和 定义 GB/T 28181、GA/T 1400.4、DB3502/T 072.1 界 定的 术语和 定义 适用 于本 文件。4 缩略语 下列缩 略语 适用 于本 文件。REST:表述 性状
9、态传 递(Representational State Transfer)SNMP:简单 网络 管理 协议(Simple Network Management Protocol)URI:统一 资源 标识 符(Uniform Resource Identifier)5 接口分 类 与 协议 结构 接口分 类 公共 安 全视频 图像 系统运 维管理 平台接 口为 运维管理 平台 和各应 用系 统专业 运维节 点的对 接接 口。一机一 档 管理 系统 作为资 源汇聚 中心,提供 统一 运 维对象 开放接 口,各类接 口交互 实体关 系见 图1,接口分类 说明 如下:运维系 统对 接接 口用 于 公
10、共安全 视频 图像 系统 运维 管理平 台和 本级 一机 一档 管理系 统专 业运维节点、下 级 公 共安 全视 频图像 系统 运维 管理 平台、前端 智能 箱系 统 专 业运 维节点 及其 他应用系统 专业 运维 节点 之间 的数据 交互;DB3502/T 072.2 2021 2 统一运 维对 象开 放接 口用 于一机 一档 管理 系统 和 公 共安全 视频 图像 系统 运维 管理平 台、前端智能箱 系统 专业 运维 节点 及其他 应用 系统 专业 运维 节点之 间的 数据 交换。视频图像系统运维管理平台前端智能箱系统专业运维节点其它应用系统专业运维节点下级视频图像系统运维管理平台运维系统
11、对接接口本级一机一档运维系统对接接口运维系统对接接口前端智能箱系统对接接口统一 运维对象 开放接口统一运维对象开放接口统一运维对象开放接口下级一机一档下级应用系统专业运维节点统一运维对象 开放接口运维系统对接接口运维系统对接接口 图1 接口交 互实 体关 系图 协议结 构 5.2.1 所有接 口交 互信 息定 义 为REST 架构 下的 资源,使 用URI 唯 一标 识。5.2.2 接口交 互连 接方 式应 支 持 HTTP 长连 接和 短连 接,实 现机制 应符 合 IETF RFC 2616 中的 相关 规定。5.2.3 应用系 统接 口访 问形 式应 符合附 录 A 中的 A.3。6 接
12、口功 能 公共功 能 6.1.1 功能要 求 应用系 统专 业运 维节 点对 接 运维 管理 平台 应支 持注 册、心 跳、告警 通知、状 态 订阅、状态 订阅 通 知等公共 功能。专有 设备 管 理系统 专业 运维 节点、前 端智能 箱系 统 专 业运 维节 点对接 运维 管理 平台,应 支持公共 功能。其 中:注册失 败时,应 延 迟 300s 内的随 机时 间后 重新 注册;注册成 功后,在10s 内未 交互信 息则 进行 心跳 保活;应用系 统专 业运 维节 点汇 聚本系 统相 关的 服务 器、服务实 例、子系 统的 异常 告警及 前端 设备告警,应上 报运 维管理 平 台。DB350
13、2/T 072.2 2021 3 6.1.2 告警 应用系 统专 业运 维节 点,汇 聚对接 应用 系统 的告 警异 常,应 对通 用应 用服 务异 常 告警进 行抽 象定 义,本文件 定义 部分 通用 告警 类型:应用系 统专 业运 维节 点代 理多个 子系 统时,各 子系 统对告 警类 型定 义不 完全 一致情 况下,和运维管理 平 台对 接时,应 用系统 专业 运维 节点 在保 证告警 码在 系统 内唯 一的 前提下,可 上报自定义 的告 警类 型;通用告 警类 型见 附 录 B 中的 B.1;告警属 性见附录 B 中的 B.2;告警级 别见附录 B 中的 B.3;告警来 源分 为应 用
14、系 统专业 运维 节点 内告 警和 邻近 系统告 警。专用功 能 6.2.1 运维系 统对 接接 口 6.2.1.1 应用系 统 专业 运 维 节点应 支持服 务实例 维护,前端 智能箱 系统 专 业运 维节点、专有 设备管 理系统专 业运 维节 点可 不支 持服务 实例 维护。应用 系 统内部 服务 实例 有变 更时,应 调用 服务 实例 增加、删除或修 改接 口。6.2.1.2 可按需 提供 应用 系统 专业 运维节 点之 间系 统 间 告警 订阅、系统 间告 警订 阅通 知 和状 态订 阅。6.2.2 前端智 能箱 系统 对接 接口 6.2.2.1 应支持 设备列 表查 询功能,运维 管
15、理平 台 通 过接口 查询 前 端智能 箱系 统 关联 的 智能 箱 列表,和一机 一档 管理 系统 的 设 备信息 进行 比对 分析,查 找是否 存在 设备 冲突。6.2.2.2 应支持 智能 控制 功能,对 前端智 能箱 系统 管理 的 智 能箱 进 行重 启、开关 电等 操作。6.2.3 统一运 维对 象 开 放接 口 6.2.3.1 应支持 向 一 机一 档 管 理系 统 查询 设备 信息,响 应 一 机一档 管理 系统 状态 结果 通知。7 接口资 源描 述 资源URI 7.1.1 运维系 统资 源URI 见附录C 中的C.1。7.1.2 应用系 统资 源URI 见附录C 中的C.2
16、。7.1.3 一机一 档 管 理系 统资源 URI 见附 录C 中的C.3。8 接口 运维 系 统对 接接 口 8.1.1 注册 8.1.1.1 交互流 程 注册交 互流 程见 图2,信 令 流程描 述如 下:DB3502/T 072.2 2021 4 a)应用系 统专 业运 维节 点向 运维管理 平台 POST 发送/nms/v1/register 请 求。应 用系统 专业 运 维节点可 以是 前端 智能 箱系 统 专业 运维 节点、下级 运 维 管理 平台、专有 设备 管 理系统 专业 运维 节点等运 维节 点;b)运维管 理平 台 将 注册 成功 与否的 响应 返回 给发 起者。专业运维
17、节点 运维管理平台1 POST/nms/v1/register2 response 图2 注册交 互流 程图 8.1.1.2 流程示 意图 注册流 程示 意图 见 图3。专业运维节点向运维管理平台 发送/nms/v1/register进行注册注册处理注册完成专业运维节点注册异常处理注册成功注册失败 图3 注册流 程示 意图 8.1.1.3 注册功 能描 述 注册功 能描 述见 表1。DB3502/T 072.2 2021 5 表1 注册功 能描 述表 URI/nms/v1/register 功能 注册 HTTP 方法 POST 请求消息体 id:35020000001370000218,pas
18、sword:xxxx 请求说明(R)id:一机一档管理系统分 配应用系统专业运维节点国标id(O)password:加密后的ID BASE64 编码 返回结果 code:0,data:token:a.b.c,message:结果说明 Token payload 内容为 exp:1554821260,-过期 时间 iat:1547608753-生成 时间 在过期时间之前调用方需要重新调用register 接口获取新的token Token 值放入后续请求header 的authorization 字段中标记已经 登录过 Authorization:Bearer a.b.c 注:R 为必选项,O
19、为可选项。8.1.2 心跳 8.1.2.1 交互流 程 心跳交 互流 程见 图4,信 令 流程描 述如 下:a)应用系 统 专 业运 维节 点 定 时向 运 维管 理平 台 GET 发送/nms/v1/heartbeat/id 请求;b)运维管 理平 台 将 心跳 成功 与否的 响应 返回 给发 起者。DB3502/T 072.2 2021 6 专业运维节点 运维管理平台1 GET/nms/v1/heartbeat/id2 response 图4 心跳交 互流 程图 8.1.2.2 流程示 意图 心跳流 程示 意图 见图5。专业运维节点向运维管理平台 发送/nms/v1/heartbeat/i
20、d运维管理平台接收心跳数据情况结束专业运维节点心跳保活异常处理心跳成功未接收到心跳数据或心跳失败 图5 心跳流 程示 意图 8.1.2.3 心跳功 能描 述 心跳功 能描 述见 表2。DB3502/T 072.2 2021 7 表2 心跳功 能描 述表 URI/nms/v1/heartbeat/id 功能 应用系统专业运维节点心跳接口 HTTP 方法 GET 请求参数 id 请求消息体 无 请求说明(R)id:一机一档管理系统分配 应用系统专业运维节点国标 id 返回结果 code:0,message:结果说明 注册后,定时向 运维管理平台发送心跳保活消息,建议 10 秒 一次 注:R 为必选
21、项,O 为可选项。8.1.3 服务实 例维 护 8.1.3.1 交互流 程 服务实 例维 护交 互流 程见 图6,信令 流程 描述 如下:a)应用系 统 专 业运 维节 点 向 运维管 理平 台发送/nms/v1/serviceInstance 增加、修改、删 除请 求;b)运维管 理平 台 将 操作 成功 与否的 响应 返回 给发 起者。专业运维节点 运维管理平台1 POST/PUT/DELETE/nms/v1/serviceInstance2 response 图6 服务实 例维 护交 互流 程图 8.1.3.2 流程示 意图 服务实 例维护 流 程示 意图 见图7。DB3502/T 07
22、2.2 2021 8 专业运维节点向运维管理平台 发送/nms/v1/serviceInstance增删改请求运维管理平台接收服务实例维护处理结束专业运维节点服务实例维护异常处理处理成功处理失败 图7 服务实 例维 护流 程示 意图 8.1.3.3 增加服 务实 例功 能描 述 增加服 务实 例功 能描 述见 表3。表3 增加服 务实 例功 能描 述表 URI/nms/v1/serviceInstance 功能 增加服务实例,可批量添加 HTTP 方法 POST 请求消息体 hardwareID:xxxx,systemID:xxxx,name:流媒体微服务 请求说明(R)hardwareID:
23、服务所属设备 ID(O)systemID:服务所属系 统ID(R)name:服务名称 返回结果 code:0,data:hardwareID:xxxx,systemID:xxxx,id:xxxxxxxx DB3502/T 072.2 2021 9 表3(续)返回结果,message:结果说明(R)id:一机一档管理系统分配 ID(R)hardwareID:服务所属设 备ID(O)systemID:服务所属系 统ID 注:R 为必选项,O 为可选项。8.1.3.4 修改服 务实 例功 能描 述 修改服 务实 例功 能描 述见 表4。表4 修改服 务实 例功 能描 述表 URI/nms/v1/se
24、rviceInstance 功能 修改服务实例,只允许修改 hardwareID(即服务和硬件设备 对应关系)HTTP 方法 PUT 请求消息体 id:xxxx,hardwareID:xxxx,systemID:xxxx,name:流媒体微服务 请求说明(R)id:服务实例 ID(一机 一档管理系统 分配)(R)hardwareID:服务所属设 备ID(O)systemID:服务所属系 统ID(R)name:服务名称 返回结果 code:0,message:结果说明 注:R 为必选项,O 为可选项。8.1.3.5 删除服 务实 例功 能描 述 删除服 务实 例功 能描 述见 表5。DB3502
25、/T 072.2 2021 10 表5 删除服 务实 例功 能描 述表 URI/nms/v1/serviceInstance/id 功能 删除服务实例 HTTP 方法 DELETE 请求消息体 id 请求说明(R)id:服务实 例 ID(一机 一档管理系统 分配)返回结果 code:0,data:id:xxxxxxxx,message:结果说明 注:R 为必选项,O 为可选项。8.1.4 告警通 知 8.1.4.1 交互流 程 告警通 知交 互流 程见 图8,信令流 程描 述如 下:a)应用系 统 专 业运 维节 点 向 运维管 理平 台发送/nms/v1/alarm 告 警通 知;b)运维管
26、 理平 台 将 操作 成功 与否的 响应 返回 给发 起者。专业运维节点 运维管理平台1 POST/nms/v1/alarm2 response 图8 告警通 知交 互流 程图 DB3502/T 072.2 2021 11 8.1.4.2 流程示 意图 告警通 知 流 程示 意图 见图9。专业运维节点向运维管理平台 发送/nms/v1/alarm运维管理平台接收告警通知结束专业运维节点告警通知异常处理处理成功处理失败 图9 告警通 知流 程示 意图 8.1.4.3 告警通 知功 能描 述 告警通 知功 能描 述见 表6。表6 告警通 知功 能描 述表 URI/nms/v1/alarm 功能 告
27、警通知接口 HTTP 方法 POST 请求消息体 timestamp:15427016032,alarmMsgs:id:31010600001320000009,name:kafka 实例,sourceId:31010600005200000009,sourceName:人脸检测系统 专业运维节点,alarmCode:70001,alarmLevel:1,alarmStatus:1,alarmTime:13234343,ip:设备 IP,DB3502/T 072.2 2021 12 表6(续)请求消息体 alarmDesc:告警描述,alarmDeal:处理建议 noticePerson:0,
28、attachment:6Ieq5a6a5LmJ5pWw5o2u 请求说明(R)id:运维对象 ID,可以是系统 运维节点 ID、系统ID、后端服 务器设备 ID、服务实例ID 或前端设备ID(R)name:运维对象名称(O)sourceId:运维节 点 ID,如果告警对象就是运维节点,该字段可不填写(O)sourceName:运维节点名称(R)alarmCode:告警码(R)alarmLevel:告警级别(见 附录表B.3)(R)alarmStatus:告警状态(0:恢复/1:告警)(R)alarmTime:告警时间(O)ip:设备 IP(R)alarmDesc:告警描述(O)alarmDea
29、l:处理建议(O)noticePerson:是否通知到 人(O)attachment:附加运维信息,需要 Base64 编码 返回结果 code:0,message:结果说明 注:R 为必选项,O 为可选项。8.1.5 状态订 阅 8.1.5.1 交互流 程 状态订 阅交 互流 程见 图10,信令 流程 描述 如下:a)运维管 理平 台 向 应用 系统 专业运 维节 点发送/subsystem/v1/subscirbe 订阅 请 求;b)应用系 统专 业运 维节 点将 操作成 功与 否的 响应 返回 给 运维 管理 平台。DB3502/T 072.2 2021 13 运维管理平台 专业运维节点
30、1 POST/subsystem/v1/subscirbe2 response 图10 状态订 阅交 互流 程图 8.1.5.2 流程示 意图 状态订 阅 流 程示 意图 见图11。运维管理平台向专业运维节点 发送/subsystem/v1/subscirbe专业运维节点状态订阅处理结束运维管理平台状态订阅异常处理处理成功处理失败 图11 状态订 阅流 程示 意图 8.1.5.3 状态订 阅功 能描 述 状态订 阅功 能描 述见 表7。DB3502/T 072.2 2021 14 表7 状态订 阅功 能描 述表 URI/subsystem/v1/subscirbe 功能 运维管理平台 订阅应用
31、系统专业运维节点状态,通过订阅通知 URI 通知给运维管理平台 HTTP 方法 POST 请求消息体 notifyURI:http:/ip:port/xxxxx 请求说明 notifyURI:订阅通 知 URI,见8.1.6 返回结果 code:0,message:结果说明 注:R 为必选项,O 为可选项。8.1.6 状态订 阅通 知 8.1.6.1 交互流 程 状态订 阅通知 交 互流 程见 图12,信令 流程 描述 如下:a)应用系 统专 业运 维节 点向 运维管 理平 台 发 送状 态通 知,实时 通知 运维 对象 状 态,包括 应用 系 统专业运 维节 点关 联的 应用 系统、服务 器
32、、服务 实例 或管理 设备 的状 态;b)运维管 理平 台 将 操作 成功 与否的 响应 返回 给应 用系 统专业 运维 节点。专业运维节点 运维管理平台1 POST notifyURI:http:/ip:port/xxxxx2 response 图12 状态订 阅通知 交 互流 程图 8.1.6.2 流程示 意图 状态订 阅通知 流 程示 意图 见图13。DB3502/T 072.2 2021 15 专业运维节点向运维管理平台发送状态订阅接口中notifyURI 定义的状态通知接口运维管理平台接收状态订阅通知结束专业运维节点状态订阅通知异常处理处理成功处理失败 图13 状态订 阅通 知流 程
33、示 意图 8.1.6.3 状态订 阅通 知功 能描 述 状态订 阅通 知功 能描 述见 表8。表8 状态订 阅通 知功 能描 述表 URI notifyURI:http:/ip:port/xxxxx 功能 应用系统 专业运维节点向运维管理平台推送状态变化通知 HTTP 方法 POST 请求消息体 id:xxxx,runStatus:0,description:转发服务异 常,timestamp:1629860811 请求说明(R)id:设 备 ID,可以是系统 ID、后端服务器设备 ID、服务 ID 或前端设备 ID(R)runStatus:运行状态(0:异常/1:正常)(O)descript
34、ion:运行状态描 述(R)timestamp:事件时间 返回结果 code:0,message:结果说明 注:R 为必选项,O 为可选项。DB3502/T 072.2 2021 16 8.1.7 系统间 告警 订阅 8.1.7.1 交互流 程 系统间 告警 订阅 交互 流程 见图14,信 令流 程描 述如 下:a)应用系 统 专 业运 维节 点 向 运维管 理平 台发送/nms/v1/subscirbe/alarm 请求;b)运维系 统将 操作 成功 与否 的响应 返回 给应 用系 统 专 业运维 节点。专业运维节点 专业运维节点运维管理平台1 POST/nms/v1/subscirbe/a
35、larm2 response 图14 系统间 告警 订阅 交互 流程 图 8.1.7.2 流程示 意图 系统间 告警 订阅 流程 示意 图见图15。专业运维节点向运维管理平台 发送/nms/v1/subscirbe/alarm运维管理平台接收系统间告警订阅结束专业运维节点系统间告警订阅异常处理处理成功处理失败 图15 系统间 告警 订阅 流程 示意 图 DB3502/T 072.2 2021 17 8.1.7.3 系统间 告警 订阅 功能 描述 系统间 告警 订阅 功能 描述 见表9。表9 系统间 告警 订阅 功能 描述 表 URI/nms/v1/subscirbe/alarm 功能 系统专业
36、运维节点间告警订阅 HTTP 方法 POST 请求消息体 ids:xxxxx,xxxxx,alarmCodes:70001,70002,alarmLevels:1,2,notifyURI:http:/ip:port/xxxxx 请求说明(O)ids:订阅应用系统专业运 维节点id,可订阅多个运维节 点,不填表示订阅所有 应用系统运维节点产生的告警(包括运维 管理平台)(O)alarmCodes:订阅告警码,可订阅多个告警码,不填表示订阅所有告警码(O)alarmLevels:订阅告警级 别,可订阅多个告警级别,不填表示订阅所有告警级别(R)notifyURI:订阅通知URI,见 8.1.8 返
37、回结果 code:0,message:结果说明 注:R 为必选项,O 为可选项。8.1.8 系统间 告警 订阅 通知 8.1.8.1 交互流 程 系统间 告警 订阅 通知 交互 流程见 图16,信 令流 程描 述如下:a)运维管 理平 台 向 应用 系统 专业运 维节 点发 送告 警通 知;b)应用系 统 专 业运 维节 点 将 操作成 功与 否的 响应 返回 给 运维 管理 平台。DB3502/T 072.2 2021 18 运维管理平台 专业运维节点1 POST notifyURI:http:/ip:port/xxxxx2 response 图16 系统间 告警 订阅 通知 交互 流程图
38、8.1.8.2 流程示 意图 系统间 告警 订阅 通知 流程 示意图 见图17。运维管理平台向专业运维节点 发送系统间告警订阅接口中notifyURI定义的告警通知接口专业运维节点接收系统间告警订阅通知结束运维管理平台系统间告警通知异常处理处理成功处理失败 图17 系统间 告警 订阅 通知 流程 示意图 8.1.8.3 系统间 告警 订阅 通知 功能 描述 系统间 告警 订阅 通知 功能 描述见 表10。DB3502/T 072.2 2021 19 表10 系统间 告警 订阅 通知 功能 描述表 URI notifyURI:http:/ip:port/xxxxx 功能 系统专业运维节点 间告警
39、订阅通知 HTTP 方法 POST 请求消息体 timestamp:15427016032,alarmMsgs:id:31010600001320000009,name:kafka 实例,sourceId:31010600005200000009,sourceName:人脸检测系统 专业运维节点,alarmCode:70001,alarmLevel:1,alarmStatus:1,alarmTime:13234343,ip:设备 IP,alarmDesc:告警描述,alarmDeal:处理建议,attachment:6Ieq5a6a5LmJ5pWw5o2u 请求说明(R)id:运维对 象 ID
40、,可以是 系统专业运维节点 ID、系统ID、后端服务器设备 ID、服务实 例ID 或前端设备ID(R)name:运维对象名称(O)sourceId:运维节 点 ID,如果告警对象就是运维节点,该字段可不填写(O)sourceName:运维节点名称(R)alarmCode:告警码(R)alarmLevel:告警级别(1:致命,2:严重,3:一般)(R)alarmStatus:告警状态(0:恢复/1:告警)(R)alarmTime:告警时间(O)ip:设备 IP(R)alarmDesc:告警描述(O)alarmDeal:处理建议(O)attachment:附加运维信息,需要 Base64 编码 D
41、B3502/T 072.2 2021 20 表10(续)返回结果 code:0,message:结果说明 注:R 为必选项,O 为可选项。8.1.9 系统间 状态 订阅 8.1.9.1 交互流 程 系统间 状态 订阅 交互 流程 见图18,信 令流 程描 述如 下:a)应用系 统 专 业运 维节 点 向 运维管 理平 台发送/nms/v1/subscribe/status 请求;b)运维管 理平 台 将 操作 成功 与否的 响应 返回 给应 用系 统 专业 运维 节点。专业运维节点 运维管理平台1 POST/nms/v1/subscribe/status2 response 图18 系统间 状
42、态 订阅 交互 流程 图 8.1.9.2 流程示 意图 系统间 状态 订阅 流程 示意 图见图19。DB3502/T 072.2 2021 21 专业运维节点向运维管理平台 发送/nms/v1/subscribe/status运维管理平台接收系统间状态订阅结束专业运维节点系统间状态订阅异常处理处理成功处理失败 图19 系统间 状态 订阅 流程 示意 图 8.1.9.3 系统间 状态 订阅 功能 描述 系统间 状态 订阅 功能 描述 见表11。表11 系统间 状态 订阅 功能 描述 表 URI/nms/v1/subscribe/status 功能 应用系统专业运维节点订阅 运维管理平台 运行信息
43、 HTTP 方法 POST 请求消息体 ids:xxxxx,xxxxx,notifyUrl:http:/ip:port/xxxxx 请求说明(O)ids:订阅运维对象ID(目 前仅支持订阅系统专业运维节点 ID),可订阅多个系统专业 运维节点,不填表示订阅所有运维对象运行状态(R)notifyUrl:订阅通知URL,见 8.1.10 返回结果 code:0,message:结果说明 注:R 为必选项,O 为可选项。8.1.10 系统间 状态 订阅 通知 DB3502/T 072.2 2021 22 8.1.10.1 交互流 程 系统间 状态 订阅 通知 交互 流程见 图20,信 令流 程描 述
44、如下:a)运维管 理平 台 向 应用 系统 发送应 用系 统 专 业运 维节 点 自定 义订 阅通 知请 求;b)应用系 统 专 业运 维节 点 将 操作成 功与 否的 响应 返回 给 运维 管理 平台。运维管理平台 应用系统1 POST notifyURI:http:/ip:port/xxxxx2 response 图20 系统间 状态 订阅 通知 交互 流程图 8.1.10.2 流程示 意图 系统间 状态 订阅 通知 流程 示意图 见图21。运维管理平台向应用系统发送应用系统专业运维节点状态订阅接口中notifyURI定义的状态通知接口专业运维节点接收系统间状态订阅通知结束运维管理平台系统
45、间状态通知异常处理处理成功处理失败 图21 系统间 状态 订阅 通知 流程 示意图 DB3502/T 072.2 2021 23 8.1.10.3 系统间 状态 订阅 通知 功能 描述 系统间 状态 订阅 通知 功能 描述见 表12。表12 系统间 状态 订阅 通知 功能 描述表 URI notifyUrl:http:/ip:port/xxxxx 功能 订阅通知接口,由应用系统 专业运维节点 实现 HTTP 方法 POST 请求消息体 id:xxxx,runStatus:0,description:转发服务异 常 timestamp:1341234123 请求说明(R)id:设 备 ID,可以
46、是系统 ID、后端服务器设备 ID、服务 ID 或前端设备 ID(R)runStatus:运行状态(0:异常/1:正常)(O)description:运行状态描 述(O)timestamp:状态变化时间 返回结果 code:0,message:结果说明 注:R 为必选项,O 为可选项。8.1.11 工单报 告 8.1.11.1 交互流 程 运维对 象发 现故 障,通过 工单方 式上 报 运 维管 理平 台,交互 流 程见 图22,信 令流程 描述 如下:a)应用系 统专 业运 维节 点向 运维管 理平 台 发 工单 报告;b)运维管 理平 台 将 操作 成功 与否的 响应 返回 给应 用系 统
47、专业 运维 节点。DB3502/T 072.2 2021 24 专业运维节点 运维管理平台1 POST/nms/v1/order2 response 图22 工单报 告 交 互流 程图 8.1.11.2 流程示 意图 工单报 告 流 程示 意图 见图23。专业运维节点向运维管理平台 发送/nms/v1/order运维管理平台接收工单报告处理结束专业运维节点工单报告异常处理处理成功处理失败 图23 工单报 告流 程示 意图 8.1.11.3 工单报 告功 能描 述 工单报 告功 能描 述见 表13。DB3502/T 072.2 2021 25 表13 工单报 告 功 能描 述表 URI/nms/
48、v1/order 功能 工单上报接口 HTTP 方法 POST 请求消息体 timestamp:15427016032,notifyUrl:http:/x.x.x.x:xxxx/orderNty,orderMsgs:username:user1,devName:湖滨南路厦禾路 路口,devGbid:32010000112000001,sourceId:31010600005200000009,sourceName:人脸检测系统 专业运维节点,alarmCode:10002,alarmLevel:1,alarmDeal:告警处理建议,alarmDesc:设备图像在夜 间非常模糊,attachme
49、nt:6Ieq5a6a5LmJ5pWw5o2u 请求说明(R)notifyUrl:工单反馈回调URL,由专业 运维节点实现(O)username:报修用户,非必 填(R)devName:运维对象名称(R)devGbid:运维对象国标ID(O)sourceId:运维节 点 ID,如果告警对象就是运维节点,该字段可不填写(O)sourceName:运维节点名称(O)alarmCode:故障码(R)alarmLevel:故障级别(R)alarmDeal:故障处理建议(R)alarmDesc:故障描述(O)attachment:附加运维信息,需要 Base64 编码 DB3502/T 072.2 20
50、21 26 表13(续)返回结果 code:0,data:orderID:xxxxxxxx,message:设备不 存在,工单上报失败!,message:结果说明(R)orderID:工单编号,为空 说明报修失败(R)message:异常描述 备注 工单编号不为空,说明工单上 报接口调用成功,但并不代表 工单已经报修成功,需要根据 8.1.12工单反馈接口中复检结果来判断,复检通过代表工单报修成功,复检不通过代表工单报修失败。注:R 为必选项,O 为可选项。8.1.12 工单反 馈 8.1.12.1 交互流 程 工单反 馈交 互流 程见 图24,信令 流程 描述 如下:a)运维管 理平 台 向