DB3502_T 072.2-2021 公共安全视频图像系统运维技术规范 第2部分：接口.docx

《DB3502_T 072.2-2021 公共安全视频图像系统运维技术规范 第2部分：接口.docx》由会员分享，可在线阅读，更多相关《DB3502_T 072.2-2021 公共安全视频图像系统运维技术规范 第2部分：接口.docx（52页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、ICS35.240CCSL773502福建省厦门市地方标准DB3502/T072.22021公共安全视频图像系统运维技术规范第2部分：接口TechnicalspecificationforoperationandmaintenanceofvideoandimagesystemforpublicsecurityPart2:Interfaces2021-12-21发布2022-01-03实施厦门市市场监督管理局发布DB3502/T072.22021目次前言.II引言.III1范围.12规范性引用文件.13术语和定义.14缩略语.15接口分类与协议结构.16接口功能.27接口资源描述.38接口.3附

2、录A（资料性）REST架构协议模型.39附录B（资料性）告警.42附录C（资料性）资源URI.44IDB3502/T072.22021前言本文件按照GB/T1.12020标准化工作导则第1部分：标准化文件的结构和起草规则的规定起草。本文件为DB3502/T072公共安全视频图像系统运维技术规范的第2部分。DB3502/T072已发布了以下部分：第1部分：总体要求；第2部分：接口；第3部分：数据元。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由厦门市安全技术防范协会提出。本文件由厦门市公安局归口。本文件起草单位：厦门市公安局、厦门市安全技术防范协会、厦门市标准

3、化研究院、苏州科达科技股份有限公司、厦门凯迪空间电子有限公司、杭州海康威视数字技术股份有限公司、罗普特科技集团股份有限公司。本文件主要起草人：李童、覃智泉、林三达、张茂林、庄毅滨、郭流流、陆通、柳少英、崔晓琳、李钊茜、夏莉、李庚、陈耿斌。IIDB3502/T072.22021引言公共安全视频图像系统在打击犯罪、治安防控、社会治理以及服务民生方面发挥了重要的作用，公共安全视频图像系统运维管理平台建设的统一和规范，将进一步提升公共安全视频图像系统运维的服务水平，有利于视频图像行业的专业化、规范化发展。DB3502/T072公共安全视频图像系统运维技术规范旨在确立公共安全视频图像系统运维管理平台总体

4、设计、接口、数据元的技术标准，为视频图像系统运维管理平台的建设提供基础规范。DB3502/T072拟由三个部分构成：第1部分：总体要求。目的在于确立公共安全视频图像系统运维管理平台关键技术路线和软件系统的组织形式，确保总体架构满足服务范围内公共安全视频图像系统运维需求，明确主要功能模块和模块间的逻辑关系，避免“过度建设”并确保“必要建设”。第2部分：接口。目的在于将公共安全视频图像系统运维管理平台对外接口标准化，明确接口在安全性、完备性、一致性、易用性、稳定性方面的要求，并从本级一机一档管理系统、下级公共安全视频图像系统运维管理平台、前端智能箱系统及其他应用系统接入等方面，明确接入的实现方式，

5、为保障建设质量及拓展应用范围提供技术支撑。第3部分：数据元。通过标准化描述公共安全视频图像系统运维管理平台的数据元和数据模型，构建标准化的数据环境，为建设数据共享、标准统一的公共安全视频图像运维管理体系提供基础规范。IIIDB3502/T072.22021公共安全视频图像系统运维技术规范第2部分：接口1范围本文件规定了公共安全视频图像系统运维管理平台的接口分类与协议结构、接口功能、接口资源描述、接口等技术要求。本文件适用于公共安全视频图像系统运维管理平台的规划设计、软件开发及接口协议的符合性测试。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用

6、文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T28181公共安全视频监控联网系统信息传输、交换、控制技术要求GA/T1400.4公安视频图像信息应用系统第4部分：接口协议要求DB3502/T072.1公共安全视频图像系统运维技术规范第1部分：总体要求IETFRFC2616超文本传输协议-HTTP/1.1（HypertextTransferProtocol-HTTP/1.1）3术语和定义GB/T28181、GA/T1400.4、DB3502/T072.1界定的术语和定义适用于本文件。4缩略语下列缩略语适用于本文件。REST:表述性状

7、态传递（RepresentationalStateTransfer）SNMP:简单网络管理协议（SimpleNetworkManagementProtocol）URI：统一资源标识符(UniformResourceIdentifier)5接口分类与协议结构接口分类公共安全视频图像系统运维管理平台接口为运维管理平台和各应用系统专业运维节点的对接接口。一机一档管理系统作为资源汇聚中心，提供统一运维对象开放接口，各类接口交互实体关系见图1，接口分类说明如下：运维系统对接接口用于公共安全视频图像系统运维管理平台和本级一机一档管理系统专业运维节点、下级公共安全视频图像系统运维管理平台、前端智能箱系统专业

8、运维节点及其他应用系统专业运维节点之间的数据交互；1DB3502/T072.22021统一运维对象开放接口用于一机一档管理系统和公共安全视频图像系统运维管理平台、前端智能箱系统专业运维节点及其他应用系统专业运维节点之间的数据交换。统一运维对象开放接口统一运维对象开放接口本级一机一档统一运维对象开放接口前端智能箱系统对接接口运维系统对接接口运维系统对接接口前端智能箱系统专业运维节点统一运维对象开放接口视频图像系统运维管理平台运维系统对接接口运维系统对接接口其它应用系统专业运维节点下级一机一档下级应用系统专业运维节点下级视频图像系统运维管理平台运维系统对接接口图1接口交互实体关系图协议结构5.2.

9、1所有接口交互信息定义为REST架构下的资源，使用URI唯一标识。5.2.2接口交互连接方式应支持HTTP长连接和短连接，实现机制应符合IETFRFC2616中的相关规定。5.2.3应用系统接口访问形式应符合附录A中的A.3。6接口功能公共功能6.1.1功能要求应用系统专业运维节点对接运维管理平台应支持注册、心跳、告警通知、状态订阅、状态订阅通知等公共功能。专有设备管理系统专业运维节点、前端智能箱系统专业运维节点对接运维管理平台，应支持公共功能。其中：注册失败时，应延迟300s内的随机时间后重新注册；注册成功后，在10s内未交互信息则进行心跳保活；应用系统专业运维节点汇聚本系统相关的服务器、服

10、务实例、子系统的异常告警及前端设备告警，应上报运维管理平台。2DB3502/T072.220216.1.2告警应用系统专业运维节点，汇聚对接应用系统的告警异常，应对通用应用服务异常告警进行抽象定义，本文件定义部分通用告警类型：应用系统专业运维节点代理多个子系统时，各子系统对告警类型定义不完全一致情况下，和运维管理平台对接时，应用系统专业运维节点在保证告警码在系统内唯一的前提下，可上报自定义的告警类型；通用告警类型见附录B中的B.1；告警属性见附录B中的B.2；告警级别见附录B中的B.3；告警来源分为应用系统专业运维节点内告警和邻近系统告警。专用功能6.2.1运维系统对接接口6.2.1.1应用系

11、统专业运维节点应支持服务实例维护，前端智能箱系统专业运维节点、专有设备管理系统专业运维节点可不支持服务实例维护。应用系统内部服务实例有变更时，应调用服务实例增加、删除或修改接口。6.2.1.2可按需提供应用系统专业运维节点之间系统间告警订阅、系统间告警订阅通知和状态订阅。6.2.2前端智能箱系统对接接口6.2.2.1应支持设备列表查询功能，运维管理平台通过接口查询前端智能箱系统关联的智能箱列表，和一机一档管理系统的设备信息进行比对分析，查找是否存在设备冲突。6.2.2.2应支持智能控制功能，对前端智能箱系统管理的智能箱进行重启、开关电等操作。6.2.3统一运维对象开放接口6.2.3.1应支持向

12、一机一档管理系统查询设备信息，响应一机一档管理系统状态结果通知。7接口资源描述资源URI7.1.1运维系统资源URI见附录C中的C.1。7.1.2应用系统资源URI见附录C中的C.2。7.1.3一机一档管理系统资源URI见附录C中的C.3。8接口运维系统对接接口8.1.1注册8.1.1.1交互流程注册交互流程见图2，信令流程描述如下：3DB3502/T072.22021a)应用系统专业运维节点向运维管理平台POST发送/nms/v1/register请求。应用系统专业运维节点可以是前端智能箱系统专业运维节点、下级运维管理平台、专有设备管理系统专业运维节点等运维节点；b)运维管理平台将注册成功与

13、否的响应返回给发起者。专业运维节点运维管理平台1POST/nms/v1/register2response图2注册交互流程图8.1.1.2流程示意图注册流程示意图见图3。专业运维节点向运维管理平台发送/nms/v1/register进行注册注册处理注册失败专业运维节点注册异常处理注册成功注册完成图3注册流程示意图8.1.1.3注册功能描述注册功能描述见表1。4URI/nms/v1/register功能注册HTTP方法POST请求消息体id:35020000001370000218,password:xxxx请求说明（R）id：一机一档管理系统分配应用系统专业运维节点国标id（O）passwor

14、d：加密后的IDBASE64编码返回结果code:0,data:token:a.b.c,message:结果说明Tokenpayload内容为exp:1554821260,-过期时间iat:1547608753-生成时间在过期时间之前调用方需要重新调用register接口获取新的tokenToken值放入后续请求header的authorization字段中标记已经登录过Authorization:Bearera.b.c注：R为必选项，O为可选项。DB3502/T072.22021表1注册功能描述表8.1.2心跳8.1.2.1交互流程心跳交互流程见图4，信令流程描述如下：a)应用系统专业运维节

15、点定时向运维管理平台GET发送/nms/v1/heartbeat/id请求；b)运维管理平台将心跳成功与否的响应返回给发起者。5DB3502/T072.22021专业运维节点运维管理平台1GET/nms/v1/heartbeat/id2response图4心跳交互流程图8.1.2.2流程示意图心跳流程示意图见图5。专业运维节点向运维管理平台发送/nms/v1/heartbeat/id未接收到心跳数据或心跳失运维管理平台接收心跳数据情况败专业运维节点心跳保活异常处理心跳成功结束图5心跳流程示意图8.1.2.3心跳功能描述心跳功能描述见表2。6URI/nms/v1/heartbeat/id功能应用

16、系统专业运维节点心跳接口HTTP方法GET请求参数id请求消息体无请求说明(R)id：一机一档管理系统分配应用系统专业运维节点国标id返回结果code:0,message:结果说明注册后，定时向运维管理平台发送心跳保活消息，建议10秒一次注：R为必选项，O为可选项。DB3502/T072.22021表2心跳功能描述表8.1.3服务实例维护8.1.3.1交互流程服务实例维护交互流程见图6，信令流程描述如下：a)应用系统专业运维节点向运维管理平台发送/nms/v1/serviceInstance增加、修改、删除请求；b)运维管理平台将操作成功与否的响应返回给发起者。专业运维节点运维管理平台1POS

17、T/PUT/DELETE/nms/v1/serviceInstance2response图6服务实例维护交互流程图8.1.3.2流程示意图服务实例维护流程示意图见图7。7URI/nms/v1/serviceInstance功能增加服务实例，可批量添加HTTP方法POST请求消息体hardwareID:xxxx,systemID:xxxx,name:流媒体微服务请求说明（R）hardwareID：服务所属设备ID（O）systemID：服务所属系统ID（R）name：服务名称返回结果code:0,data:hardwareID:xxxx,systemID:xxxx,id:xxxxxxxx8DB3

18、502/T072.22021专业运维节点向运维管理平台发送/nms/v1/serviceInstance增删改请求处理失败运维管理平台接收服务实例维护处理专业运维节点服务实例维护异常处理处理成功结束图7服务实例维护流程示意图8.1.3.3增加服务实例功能描述增加服务实例功能描述见表3。表3增加服务实例功能描述表URI/nms/v1/serviceInstance功能修改服务实例，只允许修改hardwareID（即服务和硬件设备对应关系）HTTP方法PUT请求消息体id:xxxx,hardwareID:xxxx,systemID:xxxx,name:流媒体微服务请求说明（R）id：服务实例ID（

19、一机一档管理系统分配）（R）hardwareID：服务所属设备ID（O）systemID：服务所属系统ID（R）name：服务名称返回结果code:0,message:结果说明注：R为必选项，O为可选项。返回结果,message:结果说明（R）id：一机一档管理系统分配ID（R）hardwareID：服务所属设备ID（O）systemID：服务所属系统ID注：R为必选项，O为可选项。DB3502/T072.22021表3（续）8.1.3.4修改服务实例功能描述修改服务实例功能描述见表4。表4修改服务实例功能描述表8.1.3.5删除服务实例功能描述删除服务实例功能描述见表5。9URI/nms/v

20、1/serviceInstance/id功能删除服务实例HTTP方法DELETE请求消息体id请求说明（R）id：服务实例ID（一机一档管理系统分配）返回结果code:0,data:id:xxxxxxxx,message:结果说明注：R为必选项，O为可选项。DB3502/T072.22021表5删除服务实例功能描述表8.1.4告警通知8.1.4.1交互流程告警通知交互流程见图8，信令流程描述如下：a)应用系统专业运维节点向运维管理平台发送/nms/v1/alarm告警通知；b)运维管理平台将操作成功与否的响应返回给发起者。专业运维节点运维管理平台1POST/nms/v1/alarm2respo

21、nse图8告警通知交互流程图10URI/nms/v1/alarm功能告警通知接口HTTP方法POST请求消息体timestamp:15427016032,alarmMsgs:id:31010600001320000009,name:kafka实例,sourceId:31010600005200000009,sourceName:人脸检测系统专业运维节点,alarmCode:70001,alarmLevel:1,alarmStatus:1,alarmTime:13234343,ip:设备IP,11DB3502/T072.220218.1.4.2流程示意图告警通知流程示意图见图9。专业运维节点向运

22、维管理平台发送/nms/v1/alarm运维管理平台接收告警通知处理失败专业运维节点告警通知异常处理处理成功结束图9告警通知流程示意图8.1.4.3告警通知功能描述告警通知功能描述见表6。表6告警通知功能描述表请求消息体alarmDesc:告警描述,alarmDeal:处理建议noticePerson:0,attachment:6Ieq5a6a5LmJ5pWw5o2u请求说明(R)id：运维对象ID，可以是系统运维节点ID、系统ID、后端服务器设备ID、服务实例ID或前端设备ID(R)name：运维对象名称(O)sourceId：运维节点ID，如果告警对象就是运维节点，该字段可不填写(O)so

23、urceName：运维节点名称(R)alarmCode：告警码(R)alarmLevel：告警级别（见附录表B.3）(R)alarmStatus：告警状态（0：恢复/1：告警）(R)alarmTime：告警时间(O)ip:设备IP(R)alarmDesc：告警描述(O)alarmDeal：处理建议(O)noticePerson：是否通知到人(O)attachment：附加运维信息，需要Base64编码返回结果code:0,message:结果说明注：R为必选项，O为可选项。DB3502/T072.22021表6（续）8.1.5状态订阅8.1.5.1交互流程状态订阅交互流程见图10，信令流程描述

24、如下：a)运维管理平台向应用系统专业运维节点发送/subsystem/v1/subscirbe订阅请求；b)应用系统专业运维节点将操作成功与否的响应返回给运维管理平台。12DB3502/T072.22021运维管理平台专业运维节点1POST/subsystem/v1/subscirbe2response图10状态订阅交互流程图8.1.5.2流程示意图状态订阅流程示意图见图11。运维管理平台向专业运维节点发送/subsystem/v1/subscirbe专业运维节点状态订阅处理处理失败运维管理平台状态订阅异常处理处理成功结束图11状态订阅流程示意图8.1.5.3状态订阅功能描述状态订阅功能描述见

25、表7。13URI/subsystem/v1/subscirbe功能运维管理平台订阅应用系统专业运维节点状态，通过订阅通知URI通知给运维管理平台HTTP方法POST请求消息体notifyURI:http:/ip:port/xxxxx请求说明notifyURI：订阅通知URI，见8.1.6返回结果code:0,message:结果说明注：R为必选项，O为可选项。DB3502/T072.22021表7状态订阅功能描述表8.1.6状态订阅通知8.1.6.1交互流程状态订阅通知交互流程见图12，信令流程描述如下：a)应用系统专业运维节点向运维管理平台发送状态通知，实时通知运维对象状态，包括应用系统专业

26、运维节点关联的应用系统、服务器、服务实例或管理设备的状态；b)运维管理平台将操作成功与否的响应返回给应用系统专业运维节点。专业运维节点运维管理平台1POSTnotifyURI:http:/ip:port/xxxxx2response图12状态订阅通知交互流程图8.1.6.2流程示意图状态订阅通知流程示意图见图13。14URInotifyURI:http:/ip:port/xxxxx功能应用系统专业运维节点向运维管理平台推送状态变化通知HTTP方法POST请求消息体id:xxxx,runStatus:0,description:转发服务异常,timestamp:1629860811请求说明(R)

27、id：设备ID，可以是系统ID、后端服务器设备ID、服务ID或前端设备ID(R)runStatus：运行状态（0：异常/1：正常）(O)description：运行状态描述(R)timestamp：事件时间返回结果code:0,message:结果说明注：R为必选项，O为可选项。DB3502/T072.22021专业运维节点向运维管理平台发送状态订阅接口中notifyURI定义的状态通知接口运维管理平台接收状态订阅通知处理失败专业运维节点状态订阅通知异常处理处理成功结束图13状态订阅通知流程示意图8.1.6.3状态订阅通知功能描述状态订阅通知功能描述见表8。表8状态订阅通知功能描述表15DB3

28、502/T072.220218.1.7系统间告警订阅8.1.7.1交互流程系统间告警订阅交互流程见图14，信令流程描述如下：a)应用系统专业运维节点向运维管理平台发送/nms/v1/subscirbe/alarm请求；b)运维系统将操作成功与否的响应返回给应用系统专业运维节点。专业运维节点运维管理平台1POST/nms/v1/subscirbe/alarm2response图14系统间告警订阅交互流程图8.1.7.2流程示意图系统间告警订阅流程示意图见图15。专业运维节点向运维管理平台发送/nms/v1/subscirbe/alarm运维管理平台接收系统间告警订阅处理失败专业运维节点系统间告警

29、订阅异常处理处理成功结束图15系统间告警订阅流程示意图16URI/nms/v1/subscirbe/alarm功能系统专业运维节点间告警订阅HTTP方法POST请求消息体ids:xxxxx,xxxxx,alarmCodes:70001,70002,alarmLevels:1,2,notifyURI:http:/ip:port/xxxxx请求说明(O)ids：订阅应用系统专业运维节点id，可订阅多个运维节点，不填表示订阅所有应用系统运维节点产生的告警（包括运维管理平台）(O)alarmCodes：订阅告警码，可订阅多个告警码，不填表示订阅所有告警码(O)alarmLevels：订阅告警级别，可订

30、阅多个告警级别，不填表示订阅所有告警级别(R)notifyURI：订阅通知URI，见8.1.8返回结果code:0,message:结果说明注：R为必选项，O为可选项。DB3502/T072.220218.1.7.3系统间告警订阅功能描述系统间告警订阅功能描述见表9。表9系统间告警订阅功能描述表8.1.8系统间告警订阅通知8.1.8.1交互流程系统间告警订阅通知交互流程见图16，信令流程描述如下：a)运维管理平台向应用系统专业运维节点发送告警通知；b)应用系统专业运维节点将操作成功与否的响应返回给运维管理平台。17DB3502/T072.22021运维管理平台专业运维节点1POSTnotify

31、URI:http:/ip:port/xxxxx2response图16系统间告警订阅通知交互流程图8.1.8.2流程示意图系统间告警订阅通知流程示意图见图17。运维管理平台向专业运维节点发送系统间告警订阅接口中notifyURI定义的告警通知接口专业运维节点接收系统间告警订阅通知处理失败运维管理平台系统间告警通知异常处理处理成功结束图17系统间告警订阅通知流程示意图8.1.8.3系统间告警订阅通知功能描述系统间告警订阅通知功能描述见表10。18URInotifyURI:http:/ip:port/xxxxx功能系统专业运维节点间告警订阅通知HTTP方法POST请求消息体timestamp:15

32、427016032,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，可以是系统专业运维节点ID、系统ID、后端服务器设备ID、服务实例ID或前端设备ID(R)name：运维对象名称(O)sourceId：运维节点ID，如果告警对象就是运维节点，该字段可不填写(O)sourceName：运维节点名称(R)alarmCode：告警码(R)alarmLevel：告警级别（1：致命，2：严重，3