状态监测中心系统接口规范-(2014-07-27).doc

中国南方电网有限责任公司 技术监督中心与状态监测中心 系统接口规范 中国南方电网责任有限公司 南方电网科学研究院有限责任公司 二零一四年六月 南方电网公司技术监督中心与状态监测中心系统接口标准规范 2 修订历史记录 日期日期版本版本说明说明作者作者 2011/9/3V0.1初稿凌晨 2011/9/5V0.2修改稿，根据讨论去除了即时数据请求功能凌晨 2011/9/8V0.3征求意见稿，增加了引用文件凌晨 2014/6/5V0.4改变数据请求时间格式徐政权 2014/7/20V0.5增加数据主动推送和请求方式徐政权 南方电网公司技术监督中心与状态监测中心系统接口标准规范 I 目目 录录 1概述概述1 1.1文档内容1 1.2定义/缩写 1 1.3引用文件1 2数据交换技术方案数据交换技术方案2 2.1数据交换方案架构2 2.2数据交换流程3 2.2.1数据视图交互流程.3 2.2.2异步数据交换流程.3 2.3数据采集方式6 2.4数据传输安全7 3接口协议接口协议7 3.1分省公司数据交换服务接口协议7 3.2南网科研院数据交换服务接口协议8 3.3南网总部数据交换服务接口协议9 4数据交换格式定义数据交换格式定义10 4.1请求数据格式定义10 4.2上报数据格式定义11 4.3处理结果反馈数据格式定义13 5附录附录14 5.1交易流水号格式14 5.2数字签名算法15 5.3返回代码定义16 5.4文件型数据定义17 5.5接口 WSDL 定义17 5.5.1南网科研院 Web Service 接口 WSDL 定义 .17 南方电网公司技术监督中心与状态监测中心系统接口标准规范 II 5.5.2分省公司 Web Service 接口 WSDL 定义 .18 5.5.3南网总部 Web Service 接口 WSDL 定义 .20 南方电网公司技术监督中心与状态监测中心系统接口规范 1 1 概述概述 1.1文档内容文档内容 本文档主要描述南方电网公司科学研究院技术监督中心与状态监测中心数据集成平 台与其他相关信息系统进行数据同步操作的接口规范，包括系统之间的数据传输协议、 数据格式、数据加密方案等内容。 1.2定义定义/缩写缩写 定义定义/缩写缩写详细定义详细定义说明说明 TCPTransfer Control Protocol传输控制协议 XMLExtensible Markup Language可扩展标记语言 DESData Encrypt Standard数据加密标准，一种应用广泛、 典型的分组交换密码算法 MD5Message Digest algorithm 5消息摘要算法 Web ServiceWeb ServiceWEB 服务 SOAPSimple Object Access Protocol简单对象访问协议 WSDLWeb Service Definition LanguageWEB 服务定义语言 南网科研院南网科研院南方电网公司科学研究院简称 数据请求者数据请求者南网科研院数据集成平台发起数据请求的信息系统 数据提供者数据提供者南网总部系统、各分省公司主站响应数据请求并发送数据的系统 1.3引用文件引用文件 南方电网公司总部安全生产管理信息系统数据交换接口规范 南方电网公司技术监督中心与状态监测中心系统接口规范 2 2 数据交换技术方案数据交换技术方案 2.1数据交换方案架构数据交换方案架构 目前南方电网总部及下属各分省公司使用的信息系统，实现语言、运行平台、数据 结构各不相同。根据目前数据请求者与数据提供者的数据集成需求，最大程度降低对业 务系统的影响，在南网科研院部署数据交换平台服务器，数据请求者和数据提供者之间 松散耦合的互连，实现分布式异构环境中高度可扩展性、容错、消息服务的服务，以确 保数据请求者与数据提供者的数据交换。 根据业务需求提供两种数据交换方式； 第一种方式：通过数据库视图访问方式将数据引入南网科研院数据集成平台，集成平台 与科研院其他中心的数据交换采用本方式； 第二种方式：制定相关业务的基于 SOAP 协议的 WEB SERVICE 服务接口，并将 WEB SERVICE 服务注册在数据交换平台服务器上，南网科研院数据集成平台与南网总部、各分 省公司主站系统可通过不同的协议与数据交换平台服务器上的服务进行数据的交互。 2.2数据交换流程数据交换流程方式方式 根据实际数据交换需求，目前定义两种具体的数据交换方式，分别为： . 主动推送数据方式（省级侧） . 主动召唤数据方式（网级侧） 2.2.1 主动推送主动推送数据方式数据方式（省级侧）（省级侧） 基于南网科研院数据集成平台与各分省公司主站系统，设备状态监测数据的交互以前 是以天为单位传送数据的， 即每次请求的数据都是前一天的全部数据，不能达到目前的 系统要求，为了使系统能尽可能取到最近的增量数据或及时处理发生的告警信息。要各 分省公司主站系统主动发送数据（定时发送）到南网科研院数据集成平台, 而不再需要 每次主动请求召唤数据；具体处理步骤如下： 1：数据提供者（各分省公司主站系统）根据接口数据要求生成业务增量数据完毕后，定 时主动发送数据给南网科研院数据集成平台；（主动推送数据，一天至少两次主动推送数据，一天至少两次） 南方电网公司技术监督中心与状态监测中心系统接口规范 3 方式说明： 定时推送：即按照固定的时间点主动发送数据（一天至少两次），每次发送数据时间固 定，但数据量不固定； 2：数据接收者收到发送的数据后，根据数据提供者提供的下载描述信息去下载增量数据 ZIP 文件；（如果下载失败或未完全下载，则系统自动重新下载），对下载完全的压缩包 进行解压缩，然后对数据进行校验或处理数据出现错误，则向数据提供者返回错误信息 流程如下图所示： 按按照照W WS S要要求求发发送送数数据据 南南网网总总部部系系统统 （南南网网科科究究院院数数据据集集成成平平台台） 各各分分省省公公司司主主站站系系统统 数数据据队队列列：优优先先处处理理 告告警警信信息息，然然后后按按照照 数数据据发发送送时时间间排排序序； 数数据据准准备备就就绪绪？ 对对数数据据进进行行 校校验验 业业务务数数据据处处理理 是 结结束束 数数据据入入库库，并并返返回回结结果果信信息息 返返回回成成功功信信息息 开开始始 组组织织业业务务数数据据 返返回回错错误误信信息息 定时或定量 发起数据请求 否 下载业务数据 返返回回错错误误信信息息 提供下载地址 主动召唤方式（网级侧） 2.2.2 主动主动召唤数据方式召唤数据方式（网级侧）（网级侧） 1) 南网总部系统（南网科研院数据集成平台）按实际需求制定一套定期数据召唤机 制，要求数据提供者（即各分省公司主站系统）根据发出的业务数据请求，并等 待各分省公司主站系统的响应，如果长时间无响应，则重新发送，直到成功为至， 2) 各分省公司主站系统数据提供者收到召唤请求后，按要求进行数据整理，并完成 数据分包工作后，向南网总部系统提交“准备就绪响应”； 南方电网公司技术监督中心与状态监测中心系统接口规范 4 3) 南网总部系统（南网科研院数据集成平台）数据接收者收到“准备就绪响应”后， 根据数据提供者提供的下载描述信息去下载增量数据 ZIP 文件，对下载完全的压 缩包进行解压缩，如果对数据进行校验或处理时出现错误，则向数据提供者返回 错误信息。 流程图如下： 南方电网公司技术监督中心与状态监测中心系统接口规范 5 2.3数据数据采集量采集量要求要求 数据采集一共有三种方式，分别为：全量数据采集、增量数据采集、增量数据推送三 种： 全量数据采集：应用于对数据源的首次采集（系统初始化），将数据源中的表或视图 的数据全部采集出来。全量数据采集的传输和处理工作量大，适用于首次数据采集或发 生重大数据灾难时的数据恢复。 增量数据采集：增量数据采集只采集自上次采集以来数据源中新增或修改的数据。增 量数据采集应该是定期的，并根据交换数据的周期制定增量数据采集的时间间隔。 增量数据推送：与增量数据采集类似，只是不再由网级侧发起请求，而是由省级主动 根据上次推送的情况，主动向网级推送自上次上送以来数据源中新增或修改的数据。增 量数据推送应该是定期、定量的，并根据交换数据的周期制定增量数据推送的时间间隔。 采集类型 数据源类型 首次采集周期性采集系统恢复 符合数据交换规范的数据源全量复制增量复制全量复制 2.4数据传输安全数据传输安全 南方电网科研院数据集成平台对其他相关系统的接口数据传输安全执行中国南方电 网公司数据交换接口标准中的数据安全传输要求。 3 接口协议接口协议 3.1分省公司数据交换服务接口协议分省公司数据交换服务接口协议 分省公司主站系统对南网科研院数据集成平台的接口实现为：由各分省公司主站系 统对外发布公共的 Web Service 接口，南网科研院数据集成平台作为 Web Service 接口 调用的客户端通过基于 HTTP 通讯协议的 SOAP 协议访问分省公司主站系统实现的 Web Service 接口进行通讯。 具体接口定义如下： 南方电网公司技术监督中心与状态监测中心系统接口规范 6 String DESInterfaceDESInterface( String strIdCode, String strIntfData, String strSignature )； 功能说明功能说明： 处理错误或者由南网科研院数据集成平台根据规范定义的接口形式将请求数据传送到 分省公司主站系统，由分省公司主站系统进行处理后返回相关的处理结果应答信息。 具体的 Web Service 定义参见附录“各分省公司 Web Service 接口 WSDL 定义”。 参数说明参数说明： strIdCode单位编码，详见数据接口规范附录“单位编码” strIntfData接口通讯请求数据 strSignature将接口通讯请求数据与单位编码相加后进行数字签名， 具体签名算法参见附录“数字签名算法” 返回值说明返回值说明： 返回值是一个采用 XML 进行描述的文本信息，包括返回代码和其它辅助信息。返回代 码定义该项交易是成功还是失败：如果成功，则返回代码是 0；如果错误，返回一个预定 义的非零错误码，并可以返回错误的细节描述。具体格式参见每个具体接口关于应答的 定义。对于不能定位具体接口类型的错误（例如：XML 格式错误、数字签名错误等）详见 （返回代码定义)，系统返回如下 XML 文本： 3.2南网科研院数据交换服务接口协议南网科研院数据交换服务接口协议 南网科研院数据集成平台对南网总部系统、分省公司主站系统的接口实现为：由南 网科研院数据集成平台对外发布公共的 Web Service 接口，南网总部系统、分省公司主 站系统作为 Web Service 接口调用的客户端通过基于 HTTP 通讯协议的 SOAP 协议访问南 网科研院数据集成平台发布的 Web Service 接口进行通讯。 具体接口定义如下： String IEPInterfaceIEPInterface( String strVersion, String strIntfData, String strPlatformsCode 南方电网公司技术监督中心与状态监测中心系统接口规范 7 String strIdCode, String strSignature )； 功能说明功能说明： 由南网总部系统、分省公司主站系统根据本接口规范定义的接口形式将请求数据传送 到南网科研院数据集成平台，由南网科研院数据集成平台进行处理后返回相关的处理结 果应答信息。 具体的 Web Service 定义参见附录“南网科研院 Web Service 接口 WSDL 定义”。 参数说明参数说明： strVersion通讯采用的接口版本，常量（1.0） strIntfData接口通讯请求数据 strPlatformsCode 服务平台编码，常量(CSG) strIdCode单位编码，详见数据接口规范附录“单位编码” strSignature将接口通讯请求数据与单位编码相加后进行数字签名， 具体签名算法参见附录“数字签名算法” 返回值说明返回值说明： 返回值是一个采用 XML 进行描述的文本信息，包括返回代码和其它辅助信息。返回代 码定义该项交易是成功还是失败：如果成功，则返回代码是 0；如果错误，返回一个预定 义的非零错误码，并可以返回错误的细节描述。具体格式参见每个具体接口关于应答的 定义。对于不能定位具体接口类型的错误（例如：XML 格式错误、数字签名错误等）详见 （返回代码定义)，系统返回如下 XML 文本： 3.3南网总部数据交换服务接口协议南网总部数据交换服务接口协议 南网总部系统对南网科研院数据集成平台接口实现为：由南网总部系统外发布公共 的 Web Service 接口，南网科研院数据集成平台作为 Web Service 接口调用的客户端通 过基于 HTTP 通讯协议的 SOAP 协议访问南网总部系统实现的 Web Service 接口进行通讯。 具体接口定义如下： String DESInterfaceDESInterface( String strIdCode, String strIntfData, 南方电网公司技术监督中心与状态监测中心系统接口规范 8 String strSignature )； 功能说明功能说明： 由南网科研院数据集成平台根据规范定义的接口形式将请求数据传送到南网总部系统， 由南网总部系统进行处理后返回相关的处理结果应答信息。 具体的 Web Service 定义参见附录“南网总部 Web Service 接口 WSDL 定义”。 参数说明参数说明： strIdCode单位编码，详见数据接口规范附录“单位编码” strIntfData接口通讯请求数据 strSignature将接口通讯请求数据与单位编码相加后进行数字签名， 具体签名算法参见附录“数字签名算法” 返回值说明返回值说明： 返回值是一个采用 XML 进行描述的文本信息，包括返回代码和其它辅助信息。返回代 码定义该项交易是成功还是失败：如果成功，则返回代码是 0；如果错误，返回一个预定 义的非零错误码，并可以返回错误的细节描述。具体格式参见每个具体接口关于应答的 定义。对于不能定位具体接口类型的错误（例如：XML 格式错误、数字签名错误等）详见 （返回代码定义)，系统返回如下 XML 文本： 4 数据交换格式定义数据交换格式定义 4.1请求数据格式定义请求数据格式定义 功能描述：功能描述：南网科研院数据集成平台向南网总部系统、各分省公司主站系统发送 获取数据的请求。 接口请求名称：接口请求名称：Query 接口应答名称：接口应答名称：QueryResponse 交易缩写：交易缩写： Q Query 基本属性：基本属性： 名称名称说明说明 id交易流水号，格式参见“交易流水号格式”。 type业务类型，详见数据接口规范附录的“业务类型定义” 南方电网公司技术监督中心与状态监测中心系统接口规范 9 start_date开始日期，同步数据包括大于等于开始日期 格式“yyyy-mm-dd hh:mm: ss”。 yyyy：4 位的年份（如 2014） mm：2 位的月份（0112） dd：2 位的日期（0131） hh： 2 位的小时(0 - 23) mm：2 位数的分钟（0-59） ss： 2 位数的秒（0-59） end_date结束日期，同步数据小于结束日期 格式“yyyy-mm-dd hh:mm: ss”。 yyyy：4 位的年份（如 2014） mm：2 位的月份（0112） dd：2 位的日期（0131） hh： 2 位的小时(0 - 23) mm：2 位数的分钟（0-59） ss： 2 位数的秒（0-59） 应答信息应答信息 QueryResponse 元素基本属性：元素基本属性： 名称名称说明说明 id调用接口时传递的流水号，必须和调用时完全一致。 return_code处理结果返回代码，0 表示成功，非零值表示对应的错误码。 return_desc返回结果描述。如果系统处理发生错误，则表示错误描述信息。 示例：示例： 接口交易请求数据：接口交易请求数据： 返回结果（交易成功）：返回结果（交易成功）： 返回结果（交易失败）：返回结果（交易失败）： 4.2推送推送数据格式定义数据格式定义 功能描述：功能描述：南网科研院数据集成平台向南网总部系统、各分省公司主站系统发送 获取数据的请求。 接口请求名称：接口请求名称：Push 接口应答名称：接口应答名称：PushResponse 交易缩写：交易缩写： P Push 基本属性：基本属性： 名称名称说明说明 id交易流水号，格式参见“交易流水号格式”。 type业务类型，详见数据接口规范附录的“业务类型定义” start_date开始日期，同步数据包括大于等于开始日期 格式“yyyy-mm-dd hh:mm: ss”。 yyyy：4 位的年份（如 2011） mm：2 位的月份（0112） dd： 2 位的日期（0131） hh： 2 位的小时(0 - 23) mm：2 位数的分钟（0-59） ss： 2 位数的秒（0-59） end_date结束日期，同步数据小于结束日期 格式“yyyy-mm-dd hh:mm: ss”。 yyyy：4 位的年份（如 2011） mm：2 位的月份（0112） dd：2 位的日期（0131） 南方电网公司技术监督中心与状态监测中心系统接口规范 11 hh： 2 位的小时(0 - 23) mm：2 位数的分钟（0-59） ss： 2 位数的秒（0-59） 应答信息应答信息 PushResponse 元素基本属性：元素基本属性： 名称名称说明说明 id调用接口时传递的流水号，必须和调用时完全一致。 return_code处理结果返回代码，0 表示成功，非零值表示对应的错误码。 return_desc返回结果描述。如果系统处理发生错误，则表示错误描述信息。 示例：示例： 接口交易请求数据：接口交易请求数据： 返回结果（交易成功）：返回结果（交易成功）： 返回结果（交易失败）：返回结果（交易失败）： 4.3上报数据格式定义上报数据格式定义 功能描述：功能描述：南网总部系统、各分省公司主站系统按要求组织的数据包文件的 URL 下载描述信息发送给南网科研院数据集成平台。 接口请求名称：接口请求名称：FeedBack 接口应答名称：接口应答名称：FeedBackResponse 南方电网公司技术监督中心与状态监测中心系统接口规范 12 交易缩写：交易缩写： F FeedBack 基本属性：基本属性： 名称名称说明说明 id交易流水号，格式参见“交易流水号格式”。 qid交易流水号，增量数据请求的 id。 type业务类型，详见数据接口规范的“业务类型定义” FeedBack 子元素子元素 DownloadURL 基本属性基本属性 名称名称说明说明 url增量数据下载地址 signature将增量数据 ZIP 文件的 MD5 与单位编码相加后进行数字签名，具 体签名算法参见附录“数字签名算法” url url 属性中的文本信息描述下载地址。 （下载采取 HTTP 协议） 南网总部信息系统、各分省公司主站系统根据南网科研院数据集成平台 Query 请求生成某时间段内增量数据，按 ZIP 文件格式进行压缩存放在南网总部 信息系统、各分省公司主站系统中，每个 ZIP 文件中 XML 文件的数据记录数不 超过 1 万条。南网科研院数据集成平台根据 URL 地址下载 ZIP 文件（ZIP 文件 数据格式参见数据接口规范的业务类型对应的数据包格式定义）。 应答信息应答信息 FeedBackResponse 元素基本属性：元素基本属性： 名称名称说明说明 id调用接口时传递的流水号，必须和调用时完全一致。 return_code处理结果返回代码，0 表示成功，非零值表示对应的错误码。 return_desc返回结果描述。如果系统处理发生错误，则表示错误描述信息。 示例：示例： 接口交易请求数据：接口交易请求数据： 南方电网公司技术监督中心与状态监测中心系统接口规范 13 返回结果（交易成功）：返回结果（交易成功）： 返回结果（交易失败）：返回结果（交易失败）： 4.4处理结果反馈数据格式定义处理结果反馈数据格式定义 功能描述：功能描述：南网科研院数据集成平台向南网总部信息系统、各分省公司主站系统 发送数据处理结果反馈信息。 接口请求名称：接口请求名称：Verify 接口应答名称：接口应答名称：VerifyResponse 交易缩写：交易缩写： V Verify 基本属性：基本属性： 名称名称说明说明 id交易流水号，格式参见“交易流水号格式”。 fid交易流水号，增量数据请求的 id。 type业务类型，详见数据接口规范附录的“业务类型定义” Verify 子元素子元素 DownloadURL 基本属性基本属性 名称名称说明说明 url增量数据下载地址 南方电网公司技术监督中心与状态监测中心系统接口规范 14 signature将增量数据 ZIP 文件的 MD5 与单位编码相加后进行数字签名，具 体签名算法参见附录“数字签名算法” return_code处理结果返回代码，0 表示成功，非零值表示对应的错误码。 return_desc返回结果描述。如果系统处理发生错误，则表示错误描述信息。 应答信息应答信息 VerifyResponse 元素基本属性：元素基本属性： 名称名称说明说明 id调用接口时传递的流水号，必须和调用时完全一致。 return_code处理结果返回代码，0 表示成功，非零值表示对应的错误码。 return_desc返回结果描述。如果系统处理发生错误，则表示错误描述信息。 示例：示例： 接口交易请求数据：接口交易请求数据： 返回结果（交易成功）：返回结果（交易成功）： 返回结果（交易失败）：返回结果（交易失败）： 南方电网公司技术监督中心与状态监测中心系统接口规范 15 5 附录附录 5.1交易流水号格式交易流水号格式 本接口规范定义的每一个接口都要求由一个唯一的交易流水号进行编码，其格式定 义如下： XyyyymmddnnnnncccffffCCCC X：1 位交易名称的缩写（具体缩写名称见接口定义中的描述） yyyy：4 位的年份（如 2004） mm：2 位的月份（0112） dd：2 位的日期（0131） nnnn：4 位针对数据交换每笔数据自动生成的交易流水编号，共 4 位十进制 整数，不足 4 位用 0 补齐（如 0078）。 ccc：3 位常量，00N。 ffff：4 位单位编码。 CCCC：4 位常量，0100。 南方电网公司技术监督中心与状态监测中心系统接口规范 16 5.2数字签名算法数字签名算法 128 比特数字摘要 加密后的请求数据 128 比特数字摘要 32 字节 16 进制表示的字符串 接口通讯请求数据或文件的 MD5单位编码 MD5 MD5 每个服务平台拥有的不同密钥32 字节 16 进制表示的字符串 注注： 具体的 MD5 算法参见相关标准； 图中两次“+”操作是指字符串