CMMB通讯平台接口规范设计方案.doc

CMMB中央通讯平台接口规范设计方案2011-2-12修订记录：版本号修订时间修订人修订内容1.12011-2-12冯帅初稿完成1.22011-3-18冯帅修改消息头定义1.32011-3-23冯帅1. 修改基础数据版本定义；2. 修改参数定义接口3. 修改设备链路接口定义；4. 修改生产数据同步接口定义5. 增加查询参数值回放接口6. 修改运维消息接口定义7. 修改同步基础数据流程描述8. 修改同步生产数据流程描述1.42011-3-31冯帅修改数据结构以适配JAVA平台，省、地市级平台接口合并1 前言1.1 方案概述本方案旨在为中央级平台与省级平台及地市级平台之间提供统一的数据传输接口。为了满足对实时数据传输、批量数据同步和按需实时传输三种数据传输需求，采用ESB作为系统数据传输平台。通过该方案能够明确省、地市级平台同中央级平台之间的系统边界，交互方式，交互内容等信息。该方案主要分为编码规范及接口设计两部分。接口设计分为以下几类：接口方式及交互系统范围，接口整体描述，接口方法描述，业务服务接口定义，关键业务流程描述，接口交换数据定义，ESB服务注册及调用方式。u 编码规范：描述CMMB系统使用的编码体系。包括：数据版本标识编码、监控对象编码、设备类型编码、设备编码、人员编码。u 接口方式及交互范围：描述中央级平台与省、地市级平台之间的接口交互方式和交换范围。u 接口整体描述：描述服务接口的主要分类。u 接口方法描述：描述接口服务的调用场景，系统间交互的数据，及对交互数据定义的规范。u 关键业务流程描述：通过关键业务的流程图及对流程图的描述，来体现服务提供方和服务调用方之间的业务流程。u 业务服务接口定义：描述服务提供者对外发布服务的服务名称，命名空间，服务参数，参数类型等内容。u 接口交换数据定义：描述各级平台提交的数据所遵循数据定义规范。2 编码规范本方案中所涉及的数据版本标识、监控对象编码、设备类型编码、设备编码、人员编码均采用CMMB监控系统软件技术方案-1227中的编码规范。除此之外，由于各级平台提供的服务应部署在相应的监控中心，因此将各平台监控中心的监控对象编码作为其在ESB中的全局标识。3 接口设计3.1 接口方式及交互范围CMMB三级平台包括：中央级平台、省级平台、地市级平台。平台之间的通讯通过ESB系统完成，对应的接口表现为WebService形式。中央级平台同省、地市级平台的交互内容主要包括：各平台监控对象信息、CMMB相关设备的实时及历史信息、人员信息。本方案用于中央级平台与省级平台、中央级平台与地市级平台之间的数据通讯。省级平台与地市级平台之间的通讯方式与数据协议不在此方案范围内。3.2 接口整体描述服务接口分为以下几类：n 设备信息服务接口：中央级平台定义受监设备的类型和参数项，并下发给省、地市级平台；中央级平台定期对省、地市级平台的监控对象部署情况进行查询，并将各地市级平台采集的设备运行历史信息进行收集汇总；地市级平台将设备告警信息推送到中央、省级平台。n 人员信息服务接口：中央级平台对省、地市级平台的工作人员信息进行查询。n 监控对象信息服务接口：中央级平台对省、地市级平台的监控对象状态信息进行查询。n 运维信息服务接口：中央级平台对省、地市级平台的运维日志进行查询和查询；各级平台之间发送运维消息（请求和通知）；中央级平台查询省、地市级平台监控对象的基础数据版本，以确定是否需要对基础数据进行更新。服务名称服务方法接口提供方接口使用方设备信息服务查询设备类型定义表中央级平台省、地市级平台查询设备实例表省、地市级平台中央级平台查询设备参数定义中央级平台省、地市级平台查询设备参数实时信息省、地市级平台中央级平台查询设备参数历史回放信息省、地市级平台中央级平台查询生产数据省、地市级平台中央级平台接收生产数据上传事件通知中央级平台省、地市级平台设定日常生产数据上传时间省、地市级平台中央级平台接收上报数据信息中央级平台省、地市级平台查询设备逻辑拓扑省、地市级平台中央级平台接收参数定义变更省、地市级平台中央级平台接收设备类型变更省、地市级平台中央级平台查询设备厂商列表中央级平台省、地市级平台接收设备厂商更新列表省、地市级平台中央级平台人员信息服务查询隶属于某监控对象下的人员信息省、地市级平台中央级平台监控对象信息服务查询监控对象资源目录省、地市级平台中央级平台查询监控对象状态所有平台所有平台设置监控对象状态省、地市级平台中央级平台查询地市级监控对象拓扑关系省、地市级平台中央级平台运维信息服务查询运维日志（日志内容格式由甲方定义）省、地市级平台中央级平台发送运维消息（运维消息内容由甲方定义）所有平台所有平台查询运维数据可扩展项定义中央级平台省、地市级平台接收运维数据可扩展项定义省、地市级平台中央级平台查询监控对象的基础数据版本标识省、地市级平台中央级平台3.3 接口方法描述3.3.1 查询设备类型定义表省、地市级平台通过此接口方法向中央级平台查询可受监测的设备类型列表。3.3.2 查询设备实例表中央级平台向省、地市级平台通过此接口方法查询最新版本的设备实例列表。设备实例属于系统基础数据，当基础数据发生变化时，系统当更新自身的数据版本标识。3.3.3 查询设备参数定义省、地市级平台通过此接口方法向中央级平台查询设备可供监测的参数定义，包括参数名称、参数类型、上报方式等。参数定义详情请参见接口交换数据定义。3.3.4 查询设备参数实时信息中央级平台通过此接口方法向省、地市级平台查询设备实例参数的实时信息。参数信息数据的定义请参见接口交换数据定义。3.3.5 查询设备参数历史回放信息中央级平台通过此接口方法向省、地市级平台查询设备实例参数从当前时间追溯至较早前某段时间内的参数历史。3.3.6 查询生产数据中央级平台通过此接口方法通知省、地市级平台将指定时间段内的生产数据上传至中央级平台的FTP。生产数据的定义请参见接口交换数据定义。3.3.7 接收生产数据上传事件通知省、或地市级平台将生产数据上传到指定的FTP后，通过该接口通知中央级平台上传完毕。3.3.8 设定日常生产数据上传时间中央级平台通过此接口方法设定各省级平台通过FTP方式上传生产数据的时间。3.3.9 接收上报数据信息地市级平台或省级平台通过此接口方法将设备异常信息实时推送给中央级平台。上报数据的定义请参见接口交换数据定义。3.3.10 查询设备逻辑拓扑中央级平台通过此接口方法查询地市级平台中各监控对象内部设备实例之间的连接关系。设备逻辑拓扑结构属于系统基础数据，当基础数据发生变化时，系统当更新自身的数据版本标识。设备逻辑拓扑结构的定义请参见接口交换数据定义。3.3.11 接收参数定义变更在运行过程中，可能会根据实际需要针对现有设备类型的受监参数进行调整，例如，提高或降低参数告警阈值，增加或去除对某些参数的监控等。通过此接口方法，中央级平台将经过调整的受监参数定义分发至各省、地市级平台。3.3.12 接收设备类型变更在运行过程中，可能根据实际需要针对现有设备类型进行调整，例如，增加新的设备类型或停用已有的设备类型。通过此接口方法，中央级平台将经过调整的设备类型列表分发至各省、地市级平台。3.3.13 查询设备厂商列表省、地市级平台通过此接口方法向中央级平台查询最新的设备厂商列表。3.3.14 接收设备厂商更新列表中央级平台通过此接口方法将变更后的设备厂商分发至各省、地市级平台。3.3.15 查询隶属于某监控对象下的人员信息中央级平台通过此接口方法查询各省、地市级平台的人员信息。人员信息定义请参见接口交换数据定义。3.3.16 查询监控对象资源目录中央级平台通过此接口方法向省级平台查询省级平台及其管辖范围内的地市级平台的监控对象资源目录。该目录是一个树形结构。监控对象资源目录属于系统基础数据，当基础数据发生变化时，系统当更新自身的数据版本标识。监控对象资源目录结构定义请参见接口交换数据定义。3.3.17 查询监控对象状态中央级平台通过此接口方法来查询省、地市级平台监控对象的启动/停止状态。3.3.18 设置监控对象状态中央级平台通过此接口方法来启用或停用省、地市级平台的监控对象。当某个监控对象被停用后，中央级平台将不再查询该监控对象的基础数据和生产数据，但仍然能够接收运维消息，同时该监控对象停止向中央级平台发送设备异常和报警信息，直至被再次启用。3.3.19 查询运维日志中央级平台通过此接口方法定期或手动汇总由省、地市级平台工作人员填写的运维日志。日志内容定义请参见接口交换数据定义。3.3.20 发送运维消息各平台之间通过此接口方法发送运维消息。运维消息内容的定义请参见接口交换数据定义。3.3.21 查询运维数据可扩展项定义运维消息中包含一些后期可扩展的数据项，如消息功能类别、消息级别、发送方式等，另外消息参数需要遵循特定的格式，而该格式也是可在后期扩展的。因此省、地市级平台需要通过此接口方法来查询由中央级平台定义的运维数据可扩展项的具体内容。运维数据可扩展项定义的内容规范请参见接口交换数据定义。3.3.22 接收运维数据可扩展项定义中央级平台通过此接口方法将新的运维数据扩展项定义分发至各省、地市级平台。3.3.23 查询监控对象的基础数据版本标识中央级平台根据下级平台监控对象的版本标识来判断是否需要对其基础数据进行同步。监控对象的基础数据若发生变化，则需更新自身的基础数据版本标识。通过此接口方法，中央级平台可查询省、地市级平台监控对象的基础数据版本标识。3.4 业务服务接口定义3.4.1 设备信息服务服务名称DeviceService服务描述设备信息服务语言版本WSDL 1.1命名空间http:/CMMB.ESBSspace服务提供者所有平台的监控对象服务包含的操作操作1getDeviceTypes操作描述查询设备类型定义表输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。输出参数类型DeviceTypeList描述设备类型定义表，格式规范参见接口交换数据定义（设备类型表）。相关错误信息错误代码错误描述0001监控对象编码不存在或不符合规范。操作2getDeviceList操作描述查询设备实例表输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2monitorObjCodeString监控对象编码，定义参见移动多媒体广播电视远程监控系统技术方案-1227。输出参数类型DeviceInstanceList描述设备实例表，详细定义参见接口交换数据定义相关错误信息错误代码错误描述0002监控对象状态为不可用。操作3getDeviceParameterDefinition操作描述查询设备参数定义输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2deviceTypeCodeString设备类型编码，定义参见移动多媒体广播电视远程监控系统技术方案-1227。输出参数类型DeviceParameterList描述设备参数定义表，定义参见接口交换数据定义（设备参数定义表）。相关错误信息错误代码错误描述0003设备类型编码不存在或编码不符合规范。操作4getDeviceParameterValue操作描述查询设备参数实时信息输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2paramValRequestGetParamValRequest参见接口交换数据定义（设备参数值查询请求）。输出参数类型GetParamValResponse描述监控对象码、设备码、设备参数码，定义参见接口交换数据定义（设备参数值应答）。相关错误信息错误代码错误描述0004设备参数编码不存在或编码不符合规范。操作5getProductDataSet操作描述查询生产数据输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2MonitorObjCodeString监控对象编码，格式规范参见移动多媒体广播电视远程监控系统技术方案-1227。3beginTimedateTime起始时间4endTimedateTime结束时间5dataFileFTPURLstring数据文件在FTP上的URL输出参数类型int描述数据准备确认 0：数据准备完毕，可以上传 1：数据尚未准备完毕，无法上传相关错误信息错误代码错误描述0005版本编号不存在或编号不符合规范。操作6notifyDataInfo操作描述接收上报数据信息输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2dataInfoNotifyData数据信息，详情参见接口交换数据定义（上报数据）。输出参数单向调用，无返回值。相关错误信息错误代码错误描述操作7getDeviceTopology操作描述查询设备逻辑拓扑结构输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2monitorObjCodeString监控对象编码，格式规范参见移动多媒体广播电视远程监控系统技术方案-1227。输出参数类型DeviceTopologyType描述设备逻辑拓扑，定义参见接口交换数据定义（设备逻辑拓扑）。相关错误信息错误代码错误描述操作8notifyDeviceParamDefChange操作描述接收参数定义变更输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2deviceParamListDeviceParameterList变更后的设备参数表，格式参见接口交换数据定义（设备参数定义表）。输出参数单向调用，无返回值。相关错误信息错误代码错误描述操作9notifyDeviceTypeChange操作描述接收设备类型变更输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2deviceTypeListDeviceTypeList设备类型列表，格式参见接口交换数据定义（设备类型表）。输出参数单向调用，无返回值。相关错误信息错误代码错误描述操作10getManufacturerInfo操作描述查询设备厂商列表输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。输出参数类型ManufacturerInfoList描述设备厂商信息表，定义参见接口交换数据定义（设备厂商信息表）。相关错误信息错误代码错误描述操作11notifyManufacturerInfoChange操作描述接收设备厂商更新列表输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2manufacturerListManufacturerInfoList设备厂商信息列表，定义参见接口交换数据定义（设备厂商信息表）。输出参数单向调用，无返回值。相关错误信息错误代码错误描述操作12notifyUploadEvent操作描述接收生产数据上报事件通知输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2UploadResultint上传结果。0：上传成功 1：上传失败输出参数类型response描述返回值。默认为0.相关错误信息错误代码错误描述操作13getParamValTrackBack操作描述查询参数历史回放信息输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2paramTrackBackRequestGetParamValTrackRequest查询参数。详情参见接口交换数据定义（查询参数回放请求）输出参数类型GetParamValTrackResponse描述查询参数回放应答。详情参见接口交换数据定义（查询从参数回放应答）相关错误信息错误代码错误描述操作14setUploadTime操作描述设定日常生产数据上传时间输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2Timetime同步时间输出参数类型Int描述设置结果。0:成功 1：失败相关错误信息错误代码错误描述3.4.2 人员信息服务服务名称StuffService服务描述人员信息服务语言版本WSDL 1.1命名空间http:/CMMB.ESBSspace服务提供者省、地市级平台的监控对象服务包含的操作操作1getStuffInfo操作描述查询隶属于某监控对象下的人员信息输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2monitorObjCodeString监控对象编码，格式规范参见移动多媒体广播电视远程监控系统技术方案-1227。输出参数类型StuffList描述人员列表，格式参见接口交换数据定义（人员信息表）。相关错误信息错误代码错误描述3.4.3 监控对象信息服务服务名称MonitorObjService服务描述监控对象信息服务语言版本WSDL 1.1命名空间http:/CMMB.ESBSspace服务提供者省、地市级平台的监控对象服务包含的操作操作1getCatalog操作描述查询监控对象资源目录输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2monitorObjCodeString监控对象编码，格式规范参见移动多媒体广播电视远程监控系统技术方案-1227。输出参数类型MonitorObjType描述监控对象资源目录，格式参见接口交换数据定义（监控对象）。相关错误信息错误代码错误描述操作2setMonitorObjStatus操作描述设置监控对象状态输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2monitorObjCodeString监控对象编码，格式规范参见移动多媒体广播电视远程监控系统技术方案-1227。3Statusint状态：0-停用；1-启用输出参数类型int描述0-成功；1-失败相关错误信息错误代码错误描述操作3getMonitorObjStatus操作描述查询监控对象运行状态输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2monitorObjCodeString监控对象编码，格式规范参见移动多媒体广播电视远程监控系统技术方案-1227。输出参数类型int描述0-正常；1-停用相关错误信息错误代码错误描述3.4.4 运维信息服务服务名称MaintenanceService服务描述运维信息服务语言版本WSDL 1.1命名空间http:/CMMB.ESBSspace服务提供者省、地市级平台的监控对象服务包含的操作操作1getMaintenanceLog操作描述查询运维日志（省、地市级平台提供）输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2monitorObjCodeString监控对象编码，格式规范参见移动多媒体广播电视远程监控系统技术方案-1227。3BeginTimeDateTime起始时间4EndTimeDateTime结束时间输出参数类型MTALog描述运维数据日志列表，格式参见接口交换数据定义（运维日志）。相关错误信息错误代码错误描述3001起始时间不得晚于结束时间操作2sendMTAMessage操作描述发送运维消息（中央、省、地市级平台提供）输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2MTAMessageDataMessageDataType运维消息数据。详情参见接口交换数据定义（运维消息数据）。输出参数 单向调用 无返回值类型描述相关错误信息错误代码错误描述3002目标用户不存在3003可扩展项不符合规范操作3notifyMTAExtendableDef操作描述接收运维数据可扩展项定义（省、地市级平台提供）输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2extendableDefMTADataExtenableDefType运维数据扩展项定义。详情参见接口交换数据定义（运维数据可扩展项定义）。输出参数单向调用，无返回值。相关错误信息错误代码错误描述操作4getMonitorObjVersion操作描述查询监控对象的基础数据版本标识（省、地市级平台提供）输入参数编号参数标识参数类型示例描述1requestHeadRequestHead消息头。包括调用方标识、接收方标识、调用时间、消息类型等。详情参见接口交换数据定义（消息头）。2monitorObjCodeString监控对象编码，格式规范参见移动多媒体广播电视远程监控系统技术方案-1227。输出参数类型DataVersionType描述基础数据版本信息。详情参见接口交换数据定义（基础数据版本标识）。相关错误信息错误代码错误描述操作5getMTAExtendableDef操作描述查询运维数据可扩展项定义（中央级平台提供）输入参数编号参数标识参数类型示例描述1requestHeadRe