视频级联GB28181协议详解-目录查询（检索）流程解析

目录查询（检索）流程解析一、前言目录查询（检索）是国标级联中用于资源推送的流程，尤其在国标级联对接中，涉及到资源数量不一致或者资源挂载不一致时，需要通过目录检索来排查和解决问题。“目录检索”在国标协议中属于“设备信息查询”业务的其中一种业务，其具体要求见《GB_T+28181-2016+公共安全视频联网_信息传输交换控制技术要求.doc》（后简称“国标2016”）7.5节，如图1.1所示。图1.1二、流程如图2.1所示，目录查询（检索）的基本要求见“国标2016”9.5.1节。重点概括为：“目录查询”属于“设备信息查询”的一种，与“设备信息查询”、“设备状态查询”、“设备配置查询”、“预置位查询”等业务采用同样的方法和流程，只不过报文不一样；“目录查询”的请求及应答采用MESSAGE的方法；如果有多条应答，应按附录N要求上报。图2.1依据如图2.2附录N“多响应消息传输”说明，目录查询（检索）流程重点可概括为：同一次查询及响应报文的SN号需要一致；响应消息应采用串行的方式上报，及下级需要收到上级对于上一条响应MESSAGE的回复（200ok/400bad），下级才能上报下一条响应MESSAGE，不可一下子将所有响应MESSAGE全部上报等上级应答。图2.2具体流程示意图见“国标2016”9.5.2节，即图2.3。图2.3在国标级联中，目录查询（检索）是两级平台之间的对接业务，因此上述流程图只需要关注两级（“源设备（上级）—SIP服务器（下级）”或者“SIP服务器（上级）—目标设备（下级）”）。综上，目录查询（检索）流程为：目录检索方（上级）向目录拥有方（下级）发送目录查询请求Message消息，消息体中包含目录查询检索条件；目录拥有方（下级）向目录检索方（上级）发送200OK，无消息体；目录拥有方（下级）向目录检索方（上级）发送目录响应报文，消息体中含具体目录信息，当一条Message消息无法传送完所有查询结果时，采用多条消息传送；目录检索方（上级）向目录拥有方（下级）发送200OK，无消息体。三、报文要求及示例3.1、目录查询请求如图3.1，目录查询请求消息体的要求见“国标2016”9.5.3.1.1，具体报文字段见A.2.4(b)。图3.1A.2.4(b)设备目录信息查询请求<!--命令类型：设备目录查询（必选）--><elementname="CmdType"fixed="Catalog"/><!--命令序列号（必选）--><elementname="SN"type="integer"minInclusivevalue="1"/><!--目标设备/区域/联网系统编码（必选）--><elementname="DeviceID"type="tg:deviceIDType"/><!--增加设备的起始时间（可选）空表示不限--><elementname="StartTime"type="dateTime"/><!--增加设备的终止时间（可选）空表示到当前时间--><elementname="EndTime"type="dateTime"/>重点总结：如图3.2，目录查询请求消息体必填字段：CmdType为Catalog，SN号，DeviceID为查询的资源编码（可以是下级域编码、行政区划编码、业务分组编码、虚拟组织编码、设备编码）；图3.23.2、目录查询应答如图3.3，目录查询应答的消息体要求见“国标2016”9.5.3.1.2及A.2.1(g)、A.2.6(c)和附录O。图3.3A.2.6(c)设备目录信息查询应答<!--命令类型：设备目录查询（必选）--><elementname="CmdType"fixed="Catalog"/><!--命令序列号（必选）--><elementname="SN"type="integer"minInclusivevalue="1"/><!--目标设备/区域/系统的编码，取值与目录查询请求相同（必选）--><elementname="DeviceID"type="tg:deviceIDType"/><!--查询结果总数（必选）--><elementname="SumNum"type="integer"/><!--设备目录项列表,Num表示目录项个数--><elementname="DeviceList"minOccurs="0"> <complexType><choiceminOccurs="0"maxOccurs="unbounded"> <elementname="Item"type="tg:itemType"/> </choice> <attributename="Num"type="integer"/> </complexType></element>其中itemType信息参考A.2.1(g)（只针对设备目录项）和附录O：A.2.1(g)设备目录项类型<complexTypename="itemType"> <sequence> <!--设备/区域/系统编码（必选）--><elementname="DeviceID"type="tg:deviceIDType"/><!--设备/区域/系统名称（必选）--> <elementname="Name"type="string"/><!--当为设备时，设备厂商（必选）--> <elementname="Manufacturer"type="string"/><!--当为设备时，设备型号（必选）--> <elementname="Model"type="string"/><!--当为设备时，设备归属（必选）--> <elementname="Owner"type="string"/><!--行政区域（必选）--> <elementname="CivilCode"type="string"/><!--警区（可选）--> <elementname="Block"type="string"/><!--当为设备时，安装地址（必选）--> <elementname="Address"type="string"/><!--当为设备时，是否有子设备（必选）1有，0没有--> <elementname="Parental"type="integer"minInclusivevalue="0"/><!--父设备/区域/系统ID（必选）--> <elementname="ParentID"type="string"/><!--信令安全模式（可选）缺省为0；0：不采用；2：S/MIME签名方式；3：S/MIME加密签名同时采用方式；4：数字摘要方式--> <elementname="SafetyWay"type="integer"minInclusivevalue="0"/><!--注册方式（必选）缺省为1；1：符合IETFRFC3261标准的认证注册模式；2：基于口令的双向认证注册模式；3：基于数字证书的双向认证注册模式--> <elementname="RegisterWay"type="integer"minInclusivevalue="1"/><!--证书序列号（有证书的设备必选）--> <elementname="CertNum"type="string"/><!--证书有效标识（有证书的设备必选）缺省为0；证书有效标识：0：无效1：有效--> <elementname="Certifiable"type="integer"minInclusivevalue="0"/><!--无效原因码（有证书且证书无效的设备必选）--> <elementname="ErrCode"type="integer"minInclusivevalue="1"/><!--证书终止有效期（有证书的设备必选）--> <elementname="EndTime"type="dateTime"/><!--保密属性（必选）缺省为0；0：不涉密，1：涉密--> <elementname="Secrecy"type="integer"minInclusivevalue="1"/><!--设备/区域/系统IP地址（可选）--> <elementname="IPAddress"type="string"/><!--设备/区域/系统端口（可选）--> <elementname="Port"type="integer"/><!--设备口令（可选）--> <elementname="Password"type="string"/><!--设备状态（必选）--> <elementname="Status"type="tg:statusType"/><!--经度（可选）--><elementname="Longitude"type="double"minOccurs="0"/><!--纬度（可选）--><elementname="Latitude"type="double"minOccurs="0"/> <Info><!--摄像机类型扩展，标识摄像机类型：1-球机；2-半球；3-固定枪机；4-遥控枪机。当目录项为摄像机时可选。--><elementname="PTZType"type="integer"minOccurs="0"/><!--摄像机位置类型扩展。1-省际检查站、2-党政机关、3-车站码头、4-中心广场、5-体育场馆、6-商业中心、7-宗教场所、8-校园周边、9-治安复杂区域、10-交通干线。当目录项为摄像机时可选。--><elementname="PositionType"type="integer"minOccurs="0"/><!--摄像机安装位置室外、室内属性。1-室外、2-室内。当目录项为摄像机时可选，缺省为1。--><elementname="RoomType"type="integer"minOccurs="0"/><!--摄像机用途属性。1-治安、2-交通、3-重点。当目录项为摄像机时可选。--><elementname="UseType"type="integer"minOccurs="0"/><!--摄像机补光属性。1-无补光、2-红外补光、3-白光补光。当目录项为摄像机时可选，缺省为1。--><elementname="SupplyLightType"type="integer"minOccurs="0"/><!--摄像机监视方位属性。1-东、2-西、3-南、4-北、5-东南、6-东北、7-西南、8-西北。当目录项为摄像机时且为固定摄像机或设置看守位摄像机时可选。--><elementname="DirectionType"type="integer"minOccurs="0"/><!--摄像机支持的分辨率，可有多个分辨率值，各个取值见以“/”分隔。分辨率取值参见附录F中SDPf字段规定。当目录项为摄像机时可选。--><elementname="Resolution"type="string"minOccurs="0"/><!--虚拟组织所属的业务分组ID，业务分组根据特定的业务需求制定，一个业务分组包含一组特定的虚拟组织。--><elementname="BusinessGroupID"type="tg:deviceIDType"minOccurs="0"/><!--下载倍速范围（可选），各可选参数以“/”分隔，如设备支持1,2,4倍速下载则应写为“1/2/4<elementname="DownloadSpeed"type="string"minOccurs="0"/><!--空域编码能力，取值0：不支持；1：1级增强（1个增强层）；2：2级增强（2个增强层）；3：3级增强（3个增强层）（可选）--> <elementname="SVCSpaceSupportMode"type="integer"minOccurs="0"/><!--时域编码能力，取值0：不支持；1：1级增强；2：2级增强；3：3级增强（可选）--> <elementname="SVCTimeSupportMode"type="integer"minOccurs="0"/></Info> </sequence> </complexType>重点总结：目录应答的SN号与目录查询请求SN号保持一致；item外层的DeviceID需跟上级目录查询请求的DeviceID保持一致；下级根据上级目录查询请求的编码（下级域编码、行政区划编码、业务分组编码、虚拟组织编码），将该目录及该目录下的所有资源全部上报。SumNum是需要上报的资源总数，DeviceListNum是该条MESSAGE上报的资源数；具体上报的资源信息在item节点下，item节点里的DeviceID是上报的资源编码。其他字段说明见A.2.1(g)（A.2.1(g)主要是上报监控点信息所需要的字段，系统目录项、行政区划、业务分组和虚拟组织的报文见附录O）。图3.4应答报文示例如图3.5：图3.5各类型目录item内报文及重点如下：（1）系统目录项图3.6重点总结：系统目录项的DeviceID是下级域编码；NCG作为下级默认会推送系统目录项，但有些三方会默认将系统目录项当做一个组织导致多了一层目录。如果不需要下级NCG推送，可以在NCG.1/conf/cascade/option.xml里DevVirtureUnit改成0，保存重启服务，关闭推送系统目录项；NCG作为上级，下级三方推送系统目录项时，NCG会根据DeviceID的符合域编码的编码规范（20位编码且11-13位是200）来判断这个资源是否是系统目录项。即使DeviceID和下级域编码一致但不符合域编码的编码规范，依然会识别为组织，且其父组织是与其本身一致（都是下级域编码），从而导致挂载死循环。只有当判断是系统目录项时，NCG会过滤不处理，不会入库。因此，新体系NCG国标级联，域编码一定要保证符合规范！（2）行政区划目录项图3.7重点总结：行政区划正常来说最多四级，编码最多8位；推送行政区划目录项时，报文只会携带DeviceID和Name字段，无其他字段注明父组织等，需要上级根据标准的行政区划编码自主实现挂载；NCG作为下级推送组织时，如果组织编码非业务分组编码（20位，11-13位是215）、非虚拟组织（20位，11-13位216），其他编码的组织推送都当做行政区划推送，即只会携带DeviceID和Name字段。但由于又不是标准的行政区划编码，导致上级无法正确挂载。因此NCG在推送行政时，一定要保证编码符合规范；NCG作为上级，下级推送行政区划编码，如果携带了Civilcode字段（国标无需携带），NCG则会根据Civilcode字段去找父组织挂载；如果下级按标准国标推送行政（只携带DeviceID和Name字段）时，NCG根据编码的“n-2”位去找父组织，找不到则挂载在主控中心下。比如33010101的编码会去找330101做父组织，330101的编码会去找3301做父组织，3301的编码会去找33做父组织，以此类推。但如果推送的编码超过了8位，就会直接挂载在主控中心，前面所说的“n-2”的逻辑不适用。（3）业务分组目录项图3.8重点总结：业务分组的编码是20位且11-13位是215；业务分组的ParentID是下级域编码，需挂载在主控中心下；虚拟组织（编码20位且11-13位是216）的根组织是业务分组，即业务分组和行政区划是两棵独立的资源树，虚拟组织不能挂载在行政区划下；按照（3）的说明可知，NCG做下级推送三方，且选择了“标准模式”（或者关闭了“混合目录”），在推送虚拟组织之前，会自动推送一个业务分组的目录，从而导致上级三方多了一级目录。选择“兼容模式”（或者开启“混合目录”）后上级检索就不会主动推送业务分组了。NCG做上级，下级三方推送业务分组时，需要选择“兼容模式”（或者开启“混合目录”）再检索，NCG才会在资源检索页面显示（选择“标准模式”（或者关闭了“混合目录”）检索，业务分组和虚拟组织会被识别成重点目录推送平台，且在资源检索页面不展示）。（4）虚拟组织目录项图3.9重点总结：虚拟组织的编码是20位且11-13位是216；报文不需要带Civilcode，只有ParentID和BusinessGroupID；NCG做下级推送三方，且选择了“标准模式”（或者关闭了“混合目录”），所有虚拟组织会携带BusinessGroupID为业务分组编码，第一级虚拟组织可以不带ParentID，从第二级虚拟组织开始携带ParentID（因为第一级虚拟组织的父节点是业务分组而不是虚拟组织，但目前对接每一级虚拟组织都会携带ParentID）；虚拟组织理论不支持挂载在行政区划下。但NCG做上级，选择“兼容模式”（或者开启“混合目录”）检索，下级推送虚拟组织的ParentID携带的是行政区划编码，则NCG会将该虚拟组织挂载到ParentID携带的行政区划下；NCG做下级，选择“兼容模式”（或者开启“混合目录”）检索，共享时如果虚拟组织的父组织编码是行政区划编码，选择“兼容模式”（或者开启“混合目录”），虚拟组织的ParentID则携带实际的父组织编码，且不会携带BusinessGroupID。（5）设备目录项（监控点）图3.10重点总结：监控点报文Civilcode和ParentID同时携带；默认不推送设备信息，而监控点没有父设备的概念，因此ParentID肯定会携带域编码（系统ID）。然后如果监控点挂载在虚拟组织下，ParentID才同时需要携带虚拟组织ID，因此：①NCG做上级，根据DeviceID判断是监控点（20位编码且11-13位是131/132）后，先看ParentID字段是否有20位11-13位是216的虚拟组织编码，如果有的话则认为该编码是监控点的父组织编码则去寻找并挂载，如果没有则按Civilcode带的编码为父组织去寻找挂载，即使ParentID是“域编码/父组织”的形式，但这个父组织不符合虚拟组织的编码规范，也无用；②NCG做下级，推送上级三方，如果监控点是挂载在