《DB32∕T 4608.2-2023 公共数据管理规范 第2部分:数据共享交换(江苏省).pdf》由会员分享,可在线阅读,更多相关《DB32∕T 4608.2-2023 公共数据管理规范 第2部分:数据共享交换(江苏省).pdf(22页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、!7,发布出版公共数据管理规范第 2部分:数据共享交换Specification for the management of public dataPart 2:Data sharing and exchanging2023-12-01 发布2024-01-01 实施CCS L 67DB32/T 4608.22023ICS 35.240.01中 国 标 准.江苏省市场监督管理局DB32/T 4608.22023前言引言1 范围12 规范性引用文件13 术语和定义14 缩略语25 职责分工26 交换体系37 数据接入58 数据归集59 数据交换910 数据安全10附录 A(资料性)接入申请表12
2、附录 B(资料性)库表数据推送示例13附录 C(资料性)服务接口状态码代码集14附录 D(规范性)服务接口文档要求16参考文献18目 次DB32/T 4608.22023前言本文件按照 GB/T 1.12020 标准化工作导则第 1 部分:标准化文件的结构和起草规则 的规定起草。本文件是 DB32/T 4608 公共数据管理规范 的第 2 部分。DB32/T 4608 已经发布了以下部分:第 1 部分:数据分类分级;第 2 部分:数据共享交换。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由江苏省政务服务管理办公室提出归口并组织实施。本文件起草单位:江苏省大数
3、据管理中心、江苏省质量和标准化研究院。本文件主要起草人:吴中东、何正庆、李萍、周成兵、朱春琴、付勍、魏房忠、孙毅、曹银美、曹磊、花凌锋、丁浩、刘晓红、王维。DB32/T 4608.22023引言公共数据是公共管理和服务机构为履行法定职责、提供公共服务收集、产生的,以电子或者其他方式记录、保存的具有公共使用价值的信息记录。规范公共数据管理、保障公共数据安全,对推动数字政府建设、提升政府治理能力和公共服务水平具有重要意义。DB32/T 4608 公共数据管理规范 旨在确立公共数据管理活动中分类分级和共享交换的准则,拟由两个部分构成。第 1 部分:数据分类分级。目的在于确立公共数据分类和分级的规则,
4、为数据应用和保护提供重要指导。第 2 部分:数据共享交换。目的在于指导开展省、市公共数据共享交换平台建设、管理和对接,规范各级公共管理和服务机构的数据接入、归集、交换共享等工作,建立健全全省一体化公共数据共享交换体系,促进全省数据高效共享和安全交换。DB32/T 4608.22023公共数据管理规范第 2部分:数据共享交换1 范围本文件规定了公共数据共享交换的职责分工、交换体系、数据接入、数据归集、数据交换及数据安全的要求。本文件适用于依托省公共数据共享交换平台开展的公共数据共享交换工作。2 规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,
5、仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。GB/T 22239信息安全技术网络安全等级保护基本要求GB/T 39477信息安全技术政务信息共享数据安全技术要求DB32/T 4040.1政务大数据数据元标准第 1 部分:总则DB32/T 4040.2政务大数据 数据元标准第 2 部分:公共数据元3 术语和定义下列术语和定义适用于本文件。3.1 公共管理和服务机构 public administration and service institution各级行政机关、法律法规授权的具有管理公共事务职能的组织、公共企事业单位。3.2 公共数据 p
6、ublic data公共管理和服务机构为履行法定职责、提供公共服务收集、产生的,以电子或者其他方式记录、保存的具有公共使用价值的信息记录。注:包括库表、文件、服务接口和消息流等形式。3.3 公共数据共享交换平台 public data sharing and exchange platform依托省电子政务外网,开展非涉密公共数据共享交换服务的平台,满足各级公共管理和服务机构跨地域、跨部门、跨层级的数据共享需求,供公共管理和服务机构发布资源,检索、申请、订阅其他机构资源。注:以下简称“共享交换平台”。3.4 机构前置节点 institution front node部署在公共管理和服务机构侧,
7、与省共享交换平台对接,用于交换和共享数据的软硬件设施。1DB32/T 4608.220233.5 机构前置库 institution front database部署在公共管理和服务机构侧,连通机构前置节点,与机构业务库桥接的独立数据库。3.6 中心前置节点 centre front node部署在省共享交换平台侧,用于接收和共享数据的软硬件设施。3.7 中心前置库 centre front database部署在省共享交换平台侧,连通中心前置节点,用于接收和共享数据的独立数据库。4 缩略语下列缩略语适用于本文件。CDC:变更数据捕获(Change Data Capture)DDL:数据定义语
8、言(Data Definition Language)JSON:JavaScript 对象标记(JavaScript Object Notation)RESTful:表述性状态传递(Representational State Transfer)URL:统一资源定位符(Uniform Resource Locator)UTF-8:Unicode 的一种可变长度字符编码(8 位元,Universal Character Set/Unicode Transformation Format)5 职责分工5.1 省公共数据运行管理机构省公共数据运行管理机构的职责主要包括:a)负责省共享交换平台建设维护
9、、运行管理和安全保障;b)按需提供机构前置节点软硬件资源环境,负责交换程序部署、账号分配,提供技术支持及咨询服务;c)归并整合省级公共管理和服务机构间的共享交换通道,与国家、设区市共享交换平台对接,建立健全全省一体化公共数据共享交换体系;d)负责公共数据共享申请审批,促进供需对接和数据回流,加强共享评价考核;e)指导设区市开展市级共享交换平台建设和管理。5.2 市公共数据运行管理机构市公共数据运行管理机构的职责主要包括:a)负责建设和管理本行政区域共享交换平台,并与省共享交换平台对接;b)归并整合本行政区域内公共管理和服务机构间的共享交换通道;c)归集共享本行政区域内的公共数据。5.3 公共管
10、理和服务机构公共管理和服务机构的职责主要包括:a)明确本机构的责任部门、负责人,做好本机构公共数据的收集获取、目录编制、共享开放、更新维2DB32/T 4608.22023护和安全保障等工作;b)数据提供方负责对提供的公共数据分类分级、源头治理和异议处理;c)数据使用方负责对使用的公共数据实施安全保护,在授权范围内使用数据;d)协助部署机构前置节点交换程序,负责对软硬件环境进行巡检维护。6 交换体系6.1 总体架构省共享交换平台上联国家平台、下联设区市平台,各级平台横向对接本行政区域公共管理和服务机构,形成横向联动、纵向贯通的数据共享交换体系。省共享交换平台提供前置机、服务接口、消息流等交换方
11、式,具备交换管理、运行监控、消息预警等能力,实现跨地域、跨部门、跨层级的数据共享和安全管控,提升公共数据共享交换的协同和效率。公共数据共享交换总体架构见图 1。6.2 交换方式6.2.1 前置机交换前置机交换主要是完成库表、文件资源的交换,适合数据量较大且需要落地的公共数据共享,应具备下列功能:a)桥接:建立机构业务运行区与机构数据交换区之间的信息通道;b)传输:实现机构前置节点与中心前置节点之间的信息处理和稳定可靠持续的信息交换;c)管理:实现共享交换过程的流程配置、部署、执行和管理。6.2.2 服务接口交换服务接口交换是通过服务网关将数据提供方的服务接口代理、授权并提供给数据使用方调用的共
12、享交换方式,适用于业务协同、信息核验等实时性要求高的数据应用场景。6.2.3 消息流交换消息流交换是以消息队列承载数据同步,实现消息流在数据提供方和数据使用方之间传递的共享交换方式,适用于数据实时共享交换场景。3DB32/T 4608.22023图 1 公共数据共享交换总体架构图4DB32/T 4608.220237 数据接入7.1 配置要求7.1.1 为确保共享交换性能,机构前置节点的相关配置参数应符合下列要求:a)服务器配置最低要求满足 4核 CPU、8G 内存和 200G 磁盘,可根据实际业务交换场景对服务器进行动态扩容;b)选用国产主流操作系统和关系型数据库,满足交换服务的正常运行需求
13、。7.1.2 机构前置节点应基于电子政务外网,配置 IP 地址、开通相应端口、调整网络策略,实现机构前置节点与省共享交换平台的网络互通。7.2 接入步骤7.2.1 接入申请公共管理和服务机构向省公共数据运行管理机构提交申请(申请表样式见附录 A),明确接入机构、机构前置节点、联系人、联系方式、平台管理员等信息。申请经审核通过后获得接入权限。7.2.2 环境准备7.2.2.1 若由省公共数据运行管理机构提供机构前置节点,经申请审核通过后,省公共数据运行管理机构发放云主机资源、安装基础软件、配置 IP 地址和端口、开通网络策略,确保机构前置节点与业务系统互联互通。7.2.2.2 若公共管理和服务机
14、构自备机构前置节点,应根据省公共数据运行管理机构的要求配置 IP 地址和端口、开通网络策略,确保机构前置节点与中心前置节点互联互通。7.2.3 账号分配省公共数据运行管理机构授权分配机构管理员账号。机构管理员负责发放和管理本机构内部账号。7.2.4 程序部署省公共数据运行管理机构在机构前置节点部署交换程序。7.2.5 接入联调公共管理和服务机构在机构前置库中创建数据库、表,省公共数据运行管理机构配合完成机构前置节点与省共享交换平台的接入联调工作。8 数据归集8.1 归集流程8.1.1 目录编制8.1.1.1 数据提供方编制本机构的数据目录,并在数据目录系统中录入、注册及发布。省公共数据运行管理
15、机构对数据目录进行审核。8.1.1.2 市共享交换平台与省共享交换平台实现数据目录级联,对数据目录进行编目、归集和管理,实现元数据管理、目录管理、目录服务。目录级联接入框架见图 2,应符合以下要求:5DB32/T 4608.22023a)省共享交换平台和市共享交换平台分别建设数据目录系统;b)市共享交换平台进行市域机构数据的编目、汇聚和管理;c)市共享交换平台从省共享交换平台获取服务接口授权,市共享交换平台数据目录系统在发布数据目录时,同时调用级联上报接口,将数据目录的元数据、数据字典等信息同步到省共享交换平台,完成数据目录级联。图 2目录级联接入框架8.1.2 资源归集根据数据资源类型,采取
16、相应的交换方式,实现各类资源向省共享交换平台的归集:a)库表类:将库表从机构前置节点归集到省共享交换平台中心前置库;b)文件类:将文件从机构前置节点归集到省共享交换平台中心前置节点;c)服务接口类:将服务接口代理注册到省共享交换平台服务网关;d)消息流类:将消息流归集到省共享交换平台消息队列。8.1.3 资源挂接数据提供方应通过数据目录系统将数据资源挂接到本机构数据目录下,建立数据目录与数据资源的关联。8.2 归集方式8.2.1 库表归集8.2.1.1 归集步骤以库表数据作为归集对象,数据提供方推送数据到机构前置库,省共享交换平台通过中心前置节点6DB32/T 4608.22023抽取数据,写
17、入省共享交换平台中心前置库。步骤如下:a)数据提供方对数据进行源头治理,按照 DB32/T 4040.1和 DB32/T 4040.2的要求和数据产生的业务规则,从完整性、规范性、准确性、一致性、及时性、可访问性对数据进行质量检查;b)数据提供方推送数据到机构前置库,首次推送全量数据,后续推送增量数据;c)数据提供方发起数据推送请求;d)省公共数据运行管理机构从机构前置库抽取数据到省共享交换平台中心前置库;e)针对省共享交换平台质检发现或由数据使用方反馈的异议数据,省公共数据运行管理机构向数据提供方派发异议数据处理工单,数据提供方收到工单后进行处理,并重新推送数据;f)数据提供方按数据更新周期
18、持续推送增量数据。8.2.1.2 归集类型支持国产主流关系型数据库的库表归集。8.2.1.3 操作要求8.2.1.3.1 机构前置库在初始化和增量交换过程中应符合下列要求:a)初始化时,添加数据库时间戳字段,命名为:jhpt_update_time;b)初始化时,添加数据增删改标记字段,命名为:jhpt_update_status;注:字段值为 I(代表 insert,新增数据)、D(代表 delete,删除数据)或 U(代表 update,修改数据)。c)初始化时,添加主键字段及索引;d)库表各字段填写中文注释,注释与资源目录信息项保持一致;e)库表如存在外键,指定外键,获取与其他库表的关系
19、,确保数据的完整性;f)正确填写时间戳字段,服务器的操作系统时钟准确、稳定;g)库表命名长度控制在 30 位以内,由大写英文字母、数字及下划线组成;h)当数据结构发生变更时,数据提供方数据结构变更信息提供给省公共数据运行管理机构,并重新推送数据;市公共数据运行管理机构的数据结构发生变更时,将原有的数据资源下线,并将变更后的数据资源注册发布。8.2.1.3.2 库表数据推送示例见附录 B。8.2.1.4 数据字典数据提供方应将本机构特有的数据字典提供给省公共数据运行管理机构备案,对于已发布统一数据标准的元数据,应按照数据字典要求提供数据,数据质量应符合要求。数据字典应至少包含建表 DDL和代码表
20、:a)DDL应包含表名、表字段、表中文名、字段中文名、字段类型、字段长度、是否主键、是否非空、外键、索引、触发器等信息;b)代码表应包含所涉及的全部代码项信息,包括代码表名称、代码表字段等。8.2.2 文件归集8.2.2.1 归集步骤以文件作为归集对象,数据提供方将文件写入机构前置节点的指定目录,省共享交换平台按时抽取,以文件方式存储,同时将具有固定结构的文件解析入库。7DB32/T 4608.220238.2.2.2 归集类型文件归集支持 csv、txt、xml、xls、xlsx、json、doc、docx、pdf、rar、zip、jpg、jpeg、gif、bmp、png 等格式。8.2.2
21、.3 文件命名数据提供方推送的文件数据,文件命名应使用“数据表名/文件名称”+“_”+“全/增量标记(F:全量/C:增量)”+“_”+“上报周期(D:日/W:周/M:月/Q:季度/H:半年/Y:年)”+“_”+“日期(8 位连续数字)”+“_”+“时间(6 位连续数字,精确到秒)”的格式。数据提供方更新文件时,新推送的文件名除日期和时间外,应与原文件名一致。示例:File_F_D_20230610_082600.txt。8.2.3 服务接口归集8.2.3.1 归集步骤以服务接口作为归集对象,数据提供方需提供原始服务接口及其说明文档,省共享交换平台通过服务网关代理后统一对外提供服务。8.2.3.
22、2 归集类型省共享交换平台可接入的服务接口类型为 RESTful 和 Web Service。8.2.3.3 归集格式服务接口的数据格式应符合下列要求:a)服务接口消息数据优先采用 JSON 格式,同时可支持 XML格式;b)服务请求和服务响应的报文均采用 UTF-8 编码,服务请求时 HTTPS 报文头域中如需填写contenttype,其值应为 application/json;c)服务请求由请求方法、资源标识符和 HTTPS 协议版本三部分组成,格式按照 https:/host/base_path/v n/resources 进行设计;d)服务响应报文由状态行、响应头部和响应消息主体三部
23、分组成。服务响应报文状态行包括报文协议及版本、状态码及状态描述两部分。请求响应状态码见附录 C的 C.1,返回错误码见 C.2。8.2.3.4 接口功能服务接口功能应符合下列要求:a)兼容性:迭代升级过程向后兼容;b)可用性:后端接口性能、可靠性满足实际需求,且平均响应时间不超过 1 s,响应成功率超过99.99%;c)防御性:设计时考虑流量控制、有效性检查,避免外部异常导致接口不可用;d)松耦性:接口与数据提供方的业务系统解耦,发生故障时不相互影响;e)扩展性:根据使用需求通过负载均衡实现服务接口横向扩展。8.2.3.5 接口要求服务接口应符合下列技术要求:a)接口协议:服务接口的通信协议使
24、用 HTTPS协议;b)接口版本:将服务接口的版本号放入 URL,支持多版本并存,版本号格式为 v n,其中 n代表版8DB32/T 4608.22023本号,为整型或浮点型;c)接口方法:每个服务接口只含一个接口方法,数据提供方在注册服务接口时标明服务接口的返回格式;d)接口参数:服务接口的传入参数在报文消息体中进行传递,不应在报文消息头传递;e)接口文档:服务接口接入省共享交换平台时,数据提供方提供服务接口使用说明文档。服务接口文档要求符合附录 D的规定。8.2.4 消息流归集8.2.4.1 归集步骤以消息数据作为归集对象,省共享交换平台通过 CDC 技术实时捕获数据提供方业务库(或前置库
25、)日志变更,对外提供消息流服务。步骤如下:a)数据提供方在业务库(或前置库)开启日志监听功能;b)数据提供方在省共享交换平台配置数据源、数据表等信息;c)数据提供方按 8.2.4.3的要求命名消息主题,创建并启动 CDC消息同步任务;d)省共享交换平台根据 CDC消息同步任务生成消息队列数据,对外提供消息流服务。8.2.4.2 归集类型支持国产主流关系型数据库的消息归集。8.2.4.3 消息命名创建消息主题,消息主题应按照机构业务库(或前置库)表名称+“_topic”进行命名,主要要求包括:a)长度控制在 80位以内;b)由大写英文字母、数字及下划线组成;c)结构为“Flow_BM_”+统一社
26、会信用代码+“_”+原始表名称+“_topic”。示例:Flow_BM_12320000466006279X_jsdata_topic。9 数据交换公共数据共享交换流程见图 3,具体要求如下。a)数据发布:数据提供方完成库表数据推送、文件上传、服务接口接入、消息流配置,并在省共享交换平台发布。b)数据申请与审核:数据使用方对所需的公共数据提出申请,省公共数据运行管理机构、数据提供方对申请进行审核反馈。c)数据提供:省共享交换平台和数据提供方做好数据提供准备。其中,库表数据提供时,数据提供方和数据使用方应先配置服务器地址、数据库类型、数据库版本等信息,省共享交换平台对机构前置节点接入联调。d)数
27、据获取:数据使用方获取所需的公共数据。其中,文件可根据下载权限直接下载获取;服务接口获取请求者身份标识、服务编码和授权码等授权信息后,完成接口对接联调。e)数据交换对账:数据提供方和数据使用方按周期、批次对公共数据交换过程中推送和接收的数据进行对账。f)数据异议反馈:数据使用方发现异议数据时,在省共享交换平台中提交工单反馈,并由数据提供方进行异议处理。9DB32/T 4608.22023g)数据续约:省共享交换平台对数据使用授权进行临期提醒,提供快速续约功能,方便数据使用方进行数据使用授权续约。h)数据结构变更:数据提供方变更申请通过后,库表数据在省共享交换平台上发布新版数据,通知数据使用方限
28、期内停用旧版数据,同时申请新版数据;文件、服务接口通过省共享交换平台变更。i)数据下线:数据提供方通过省共享交换平台提交下线申请,审核通过后,尚未被申请使用,直接下线;已被申请使用,通知数据使用方期限内(30日)调整,到期后自动下线。图 3共享交换流程10 数据安全10.1 基本要求各级共享交换平台应满足 GB/T 22239 中三级网络安全等级保护要求和 GB/T 39477 中共享数据交换安全要求,在节点管理、授权管理、数据管控等方面发现不符合安全要求的,应及时整改。10.2 节点管理机构前置节点应按要求进行安全防护,要求包括但不限于:a)配置边界防火墙,按照最小化原则设置网络安全访问策略
29、;10DB32/T 4608.22023b)配备病毒防护系统、漏洞扫描和补丁管理系统,提供主机安全服务;c)采取安全认证措施和安全管理策略,安全管理系统账号;d)对操作系统、数据库、网络设备等的防病毒、系统补丁进行集中管理;e)对交换节点服务器和操作终端进行安全运维管理,主要操作可审计、可回溯。10.3 授权管理省共享交换平台应对数据提供方、数据使用方、公共数据运行管理机构进行权限控制,要求包括但不限于:a)对数据提供方和数据使用方进行身份和权限验证,避免非法请求;b)公共数据申请审批通过后才能进行交换订阅、授权;c)申请的公共数据应进行有效期验证,过期的公共数据无法继续使用;d)数据提供方对
30、服务接口进行使用授权,数据使用方通过唯一授权码进行接口调用,未经授权不应提供第三方使用;e)加强省共享交换平台接入口和接入终端的安全保密管理,采取入侵防范、恶意代码检测以及信息涉密情况检查等措施,提高防病毒、防攻击、防信息泄露、数据防篡改及防窃取等能力;f)可通过设置各机构前置节点 IP地址或账户的黑白名单控制其访问权限。10.4 数据管控应对公共数据共享交换过程进行安全管控,要求包括但不限于:a)数据提供方:定期检查和评估本机构业务运行区至数据交换区数据传输的安全性和可靠性;根据数据分类分级标准结合实际情况对所提供的公共数据进行分类分级;根据数据的敏感程度,对相应数据实施加密、脱敏等处理。b
31、)数据使用方:定期检查和评估本机构数据交换区至业务运行区数据传输的安全性和可靠性;根据数据分类分级标准对使用的公共数据实施安全保护,在授权范围内合规使用;对数据泄露、非授权使用等情形实时监测告警,并及时处置、报告。c)公共数据运行管理机构:定期检查和评估本级共享交换平台数据传输的安全性和可靠性;对本级数据共享交换通道运行情况实时监测告警,并及时处置;实时监测服务接口调用,对调用频次异常、调用超时、调用错误、非授权调用等情况及时告警处置;采用隐私计算、数据沙箱、数据水印等技术,加强数据使用安全管控;对数据提供方、数据使用方、公共数据运行管理机构的操作行为和数据交换等进行审计。11DB32/T 4
32、608.22023附录A(资料性)接入申请表接入申请表样式见表 A.1。表 A.1省公共数据共享交换平台接入申请表申请人信息申请人机构信息申请机构统一社会信用代码管理员账号信息(账号权限:可对该机构进行管理授权、资源申请审核、账号新增,管理员账号为本机构最大权限账号)姓名工作人员账号使用者信息(账号权限:可操作省平台进行申请,资源目录注册、统一工单使用等功能性权限)姓名备注说明机构首次申请可开通一个管理员账号和一个工作人员账号,且一个机构只能拥有一个管理员账号,其他工作人员账号由管理员自行开设机构盖章 年 月 日联系电话手机号手机号12DB32/T 4608.22023附录B(资料性)库表数据
33、推送示例B.1 新增数据新增库表数据的推送示例见表 B.1。表 B.1新增库表数据推送示例rowguid(唯一主键)6a4cfbd01d103523f426e2fffb77e55248a45044467c84ddxm(姓名)王*李*刘*陈*sfzh(身份证号)32010119*000132010319*000332010419*000432010519*0005fs(分数)60606060jhpt_update_time(时间戳)20230612 17:12:1320230612 17:12:1320230612 17:12:1320230612 17:12:13jhpt_update_sta
34、tus(数据增删改标记)IIIIB.2 修改数据修改库表数据的推送示例见表 B.2。表 B.2修改库表数据推送示例rowguid(唯一主键)6a4cfbd01d103523f426e2fffb77e55248a45044467c84ddxm(姓名)王*李*刘*陈*sfzh(身份证号)32010119*000132010319*000332010419*000432010519*0005fs(分数)88909178jhpt_update_time(时间戳)20230613 15:17:1220230613 15:17:1220230613 15:17:1220230613 15:17:12jhp
35、t_update_status(数据增删改标记)UUUUB.3 删除数据删除库表数据的推送示例见表 B.3。表 B.3删除库表数据推送示例rowguid(唯一主键)6a4cfbd01d103523f426e2fffb77e55248a45044467c84ddxm(姓名)王*李*刘*陈*sfzh(身份证号)32010119*000132010319*000332010419*000432010519*0005fs(分数)88909178jhpt_update_time(时间戳)20230614 10:13:1420230614 10:13:1420230614 10:13:1420230614
36、 10:13:14jhpt_update_status(数据增删改标记)DDDD13DB32/T 4608.22023附录C(资料性)服务接口状态码代码集C.1 服务接口请求响应状态码服务接口请求响应状态码见表 C.1。表 C.1服务接口请求响应状态码编码100200201202204400401403404405406409410412429500501503说明ContinueOKCreatedAcceptedNo ContentBad RequestUnauthorizedForbiddenNot FoundMethod Not AllowedNot AcceptableConflict
37、GonePrecondition FailedToo many requestsInternal Server ErrorNot ImplementedService UnavailableC.2 服务接口返回错误码服务接口返回错误码见表 C.2。表 C.2服务接口返回错误码E001E002请求体未携带数据包头数据包头中第一个子节点为空编码说明14DB32/T 4608.22023E004E005E006E007E008E009E010E100E101E102E103E104E105E106E107E108E109E1021E110R001R002R003R004R005R006请求数据格式有
38、错误权限认证失败请求失败出错认证数据同步异常请求超时调用失败没有进行过数据同步的初始化过程,无法得到服务表信息服务不存在于数据库服务列表中服务已过期没有进行过数据同步的初始化过程,无法得到服务表信息请求 ID不存在于数据库请求列表中没有进行过数据同步的初始化过程,无法得到服务表信息请求不存在于数据库授权列表中没有进行过数据同步的初始化过程,无法得到服务表信息输入的密钥错误密钥验证失败服务已停止(下线)密钥已过期获取头信息进入应急通道未携带附件调用真正的服务地址调用成功调用结束表 C.2服务接口返回错误码(续)编码说明15DB32/T 4608.22023附录D(规范性)服务接口文档要求D.1
39、接口归集内容服务接口的基本信息应至少包含下列内容:a)接口名称:服务接口的中文名称;b)接口描述:对服务接口的功能、使用场景等进行描述;c)接口类型:服务接口类型,如 RESTful、Web Service;d)请求方式:服务接口请求方式,如 GET、POST;e)调用频次:对最大允许调用频次和瞬时并发量进行说明,例如:5万次/d和 2千次/s;f)超时时间:服务接口调用超时时长,根据实际情况填写;g)共享类型:有条件共享、无条件共享或不予共享;h)共享条件:数据共享的行政依据和法律法规;i)授权类型:整体授权或非整体授权;j)数据更新周期:服务接口后端数据源的更新周期,例如:每天、每周、每月
40、;k)URL:服务接口的 IP地址、端口号以及服务的详细路径;l)请求头域:请求头中需要传入参数的含义描述;m)头域样例:请求头域的传值格式样例;n)输入参数:对请求报文中各个输入参数的含义、字段类型、长度等进行详细描述,并给出填写指导,如需填写代码,给出对应代码表;o)输入样例:提供典型场景下服务接口的完整调用示例,调用示例中涉及到的敏感信息可脱敏后呈现,并做出相关说明;p)响应头域:响应数据的格式说明;q)输出参数:对返回报文中各个输出参数的含义、字段类型、长度等进行详细描述,如包含返回代码,给出对应代码表;r)输出样例:提供典型场景下服务接口请求成功和失败时的返回数据示例,返回示例中涉及
41、的敏感信息可脱敏后呈现,并做出相关说明。D.2 服务接口使用说明文档示例服务接口使用说明文档示例见表 D.1。表 D.1服务接口使用说明文档示例接口名称接口描述接口类型请求方式调用频次共享类型人员信息查询接口可用于查询对应人员的手机号码及户籍地址信息的服务RESTfulPOST5万次/d有条件共享超时时间共享条件30 000 ms有行政依据,符合国家法律法规16DB32/T 4608.22023授权类型URL请求头域头域样例输入参数输入样例响应头域输出参数输出样例备注https:/IP:PORT/base_path/v1/resources参数名AuthorizationAuthorizati
42、on:Bearer xxxxxxxxx参数名xmsfzhm请求数据格式为 application/jsonxm:xxxx,sfzhm:xxxxxx使用状态码参数名dataxmsfzhmsjhmhjdzstatusmsg请求成功时:data:xm:张*,sfzhm:32010519*,sjhm:13851*,hjdz:南京市建邺区汉中门大街 145号 ,status:0,msg:查询成功请求失败时:data:,status:-1,msg:输入参数不正确该接口一次调用只能查询一个人员的信息整体授权类型stringstringstringstringstringstringstring类型Strin
43、g类型stringstring长度255255255255255255255长度255长度255255必选是是是是是是是数据更新周期说明数据集姓名身份证号码手机号码户籍地址查询状态:0:查询成功-1:输入参数不正确-2:其他未定义的异常提示信息必选是必选是是实时说明密钥验证说明姓名身份证号码示例data:xm:张*sfzhm:32010519*sjhm:13851*hjdz:南京市建邺区汉中门大街 145号status:0msg:查询成功示例Bearer xxxxxxxxx示例xm:张*sfzhm:32010519*表 D.1服务接口使用说明文档示例(续)17DB32/T 4608.22023参 考 文 献1 GB/T 21062.12007政务信息资源交换体系第 1部分:总体框架2 GB/T 21062.22007政务信息资源交换体系第 2部分:技术要求3 GB/T 21062.42007政务信息资源交换体系第 4部分:技术管理要求4 政务信息资源共享管理暂行办法(国发 2016 51号)5 政务信息系统整合共享实施方案(国办发 2017 39号)6 江苏省公共数据管理办法(省政府令第 148号)7 江苏省政务信息资源共享管理暂行办法(苏政发 2017 133号)18