标准规范下载简介

Q／CR 821-2021 铁路数据服务平台接口规范.pdf

ICS 03.220.30

nterfacespecificationofrailwaydataserviceplatform

中国国家铁路集团有限公司发布

CJJ 13-2013-T：供水水文地质钻探与管井施工操作规程（无水印，带书签）前言 范围. 规范性引用文件 术语和定义 缩略语…. 总体要求… 文件交换方式 6.1通用要求 6.2接口a(文件接收) 6.3接口b(文件共享) web服务方式 7.1通用要求 7.2接口c（服务发布） 7.3接口d（服务调用） 8消息队列方式 8.1通用要求 8.2接口e(消息生产） 8.3接口f(消息消费） 附录A（规范性）错误信息 附录B（规范性）数据格式 参考文献

本文件按照GB/T1.1一2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规 定起草。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。 本文件由中国铁道科学研究院集团有限公司电子计算技术研究所归口。 本文件起草单位：中国铁道科学研究院集团有限公司电子计算技术研究所、中国铁路北京局集团 有限公司、中国铁路广州局集团有限公司。 本文件主要起草人：马志强、马小宁、吴艳华、刘彦军、武威、孙远运、朱建生、李平、周亮瑾、徐贵红 刘忠东、张艳祥、周发明、刘飞、王洪业、刘庆猛、刘敏、赵正阳、杨森、刘艺飞、邹丹、张晓栋、徐温雅 余振国、钱琳、李靠鹏、王佳琦。 本文件版权归中国国家铁路集团有限公司所有，任何单位和个人未经许可不得复制及转让。

铁路数据服务平台接口规范

本文件规定了铁路数据服务平台数据接口的总体要求和各接口方式的相关要求 本文件适用于铁路数据服务平台数据接口的开发、测试和应用等。

消息的发送者messagesender 产生消息的应用程序 [来源：GB/T28168—2011,3.1.3 3.6 消息的接收者messagereceiver 接收消息的应用程序。 「来源：GB/T28168—2011.3.1.4

下列缩略语适用于本文件。 HTTP：超文本传输协议（HyperText TransferProtocol) JSON：JavaScript对象标记（JavaScript ObjectNotation） REST：表述性状态传递（RepresentationalStateTransfer） SFTP：安全文件传送协议（SSHFileTransferProtocol)

接口a、b是铁路数据服务平台与铁路信息系统之间的文件交换方式接口；铁路信息系统从铁路 服务平台获取认证信息（authorization），传输数据时宜通过加密算法进行数据加密传输。

6.2接口a（文件接收）

采用SFTP协议进行文件交换时，获取SFTP配置信息的接口名称为“sftpInfo”，请求方式为 "POST"，输入参数应符合表1的规定，调用成功返回信息应符合表2的规定，调用失败返回信息应符合 表3的规定

表2调用成功返回信息表

采用SFTP协议进行文件交换时，获取SFTP配置信息的接口名称为“sftplnfo”，请求方 “POST"，输人参数应符合表1的规定，调用成功返回信息应符合表2的规定，调用失败返回信息应 表3的规定

web服务方式接口分为接口c服务发布和接口d服务调用。服务发布接口分为结构化数据导入和 接口、非结构化数据导入和共享接口，服务调用接口分为结构化数据和非结构化数据的导人接口 web服务方式接口宜采用Rest协议进行传输。 返回结果的错误信息应符合附录A的规定。

7.2.1结构化数据导入

采用Rest协议进行数据传输时，数据导入接口名称为“datason”，请求方式为“POST”，输入参数应 符合表4的规定，调用成功返回信息应符合表5的规定，调用失败返回信息应符合表6的规定。传输的 数据应符合附录B的规定

表6 调用失败返回信息表

采用Rest协议进行数据传输时，数据共享的接口名称为“queryData”，请求方式为“POST”，输入参 符合表7的规定，调用成功返回信息应符合表8的规定，调用失败返回信息应符合表9的规定。 传 数据应符合附录B的规定

表12调用失败返回信息表

7.2.4.1获取文件的目录信息

用Rest协议进行数据传输时，获取文件目录下所有文件夹及文件的元数据信息的接口名称为 talogInfo”，请求方式为“POST”，输入参数应符合表13的规定，调用成功返回信息应符合表14的 周用失败返回信息应符合表15的规定。传输的数据应符合附录B的规定。

表14调用成功返回信息表

表15调用失败返回信息表

采用Rest协议进行数据传输时，获取文件的接口名称为“fetchFile”，请求方式为“GET"，输人参数 合表16的规定，调用成功返回信息应符合表17的规定，调用失败返回信息应符合表18的规定

表17调用成功返回信

采用Rest协议进行数据传输时，获取文件对应的MD5信息的接口名称为“fetchFileMd5”，请求方

式为“GET”，输人参数应符合表19的规定，调用成功返回信息应符合表20的规定，调用失败返回信息 应符合表21的规定

表20调用成功返回信息表

重庆来福士广场T3N塔楼住宅74层-强电.pdf表21调用失败返回信息表

采用Rest协议进行数据传输时，数据导入接口名称为"structDataimpor”，其他要求应符合7.2.1的 规定。

采用Rest协议进行数据传输时， unstructDataimpor”，其他要求应符合7.2.3 的规定

消息队列方式接口宜采用kafka、MQ等中间件进行传输，返回结果的错误信息应符 规定。

8.2接口e（消息生产）

基于kafka的消息队列方式的接口进行数据传输时化工库改造工程施工组织设计，获取消息队列生产者配置信息的接口名 “kafkaProducerlnfo”，请求方式为“POST”，输人参数应符合表22的规定，调用成功返回信息应 表23的规定，调用失败返回信息应符合表24的规定

表23调用成功返回信

表24调用失败返回信息表