48 KiB
研发云平台互联互通规范总册(试行稿)
脱敏整理版:已移除编制人员、联系人和联系方式,并合并无意义硬换行。技术条款、章节和示例以原始 DOCX 为争议核验依据。
研发云平台互联互通规范
总 册
中国电信股份有限公司研究院研发云平台运营中心
2025 年 5 月
版本变更历史
1 文档说明
1.1 编制说明
本规范旨在明确研发云平台与外部系统之间的互联互通要求,确保双方在技术实现、数据交换、安全管理和用户体验等方面达成一致,指导开发、测试和运维团队进行系统集成,提高集成效率,降低集成风险,确保系统的稳定运行和用户体验的连贯性。
1.2 文档结构
本规范由文档说明、总体要求、组织分工、互联互通方式及管理流程,互联互通安全要求、附件等部分构成,各章节的主要内容如下:第 1 章文档说明,对规范的编制、文档结构、使用范围、起草单位、解释权、版权和本规范用到的术语进行说明;第 2 章总体要求,对规范的编制原则进行说明;第 3 章组织、分工和职责,说明在研发云互联互通涉及的各个组织,以及他们在互联互通中的分工和职责;第 4 章平台互联互通方式,描述外部系统及服务与研发云互联互通的方式,包括在系统和服务集成、能力使用以及数据交互等;第 5 章互联互通管理流程,描述在互联互通的申请、实施及运营维护方面相关的流程和管理要求;第 6 章网络对接方案,描述研发单位现有开发测试资源接入研发云的网络接入方案,研发单位可以根据自己的具体情况选择其中一种方式接入;第 7 章互联互通安全要求,描述为保障互联互通后的系统以及数据的安全性,对实现技术、实施方案以及管理上的安全要求;附件包括在互联互通实施过程中涉及的申请模板、流程指引等内容。
1
1.3 适用范围
本规范适用于研发云平台与外部系统及服务的集成,能力开放、数据交换等场景。
1.4 起草单位
本规范的起草单位是中国电信股份有限公司研究院研发云平台运营中心。
1.5 解释权
本规范解释权属于中国电信股份有限公司研究院研发云平台运营中心。
1.6 版权
本规范的版权属于中国电信股份有限公司研究院研发云平台运营中心。
1.7 名词解释
2 总体要求
2.1 总体原则
- 标准化与规范化原则:所有集成接口和数据交换应遵循标准化的协议和格式,如 OpenAPI、OIDC 等。数据格式应统一,例如使用 JSON 或XML。这有助于确保不同系统之间的兼容性和互操作性2. 安全性与隐私保护原则:在集成过程中,必须确保数据的安全性和用户的隐私。这包括使用加密协议(如 HTTPS)、身份验证和授权机制(如 OAuth2、JWT)、以及数据加密存储。3. 高可用性与容错性原则:集成系统应具备高可用性和容错能力,确保在部分系统故障时,整个系统仍然可以正常运行。4. 以用户为中心的设原则:在制定系统对接方案时,需要始终以用户为中心,确保用户体验的连贯性和一致性。这包括简化用户操作流程、提供清晰的反馈信息、优化界面设计以及确保系统的响应速度。
3 组织、分工和职责
3.1 集团科技创新部
集团科技创新部是研发云互联互通的统筹管理部门,主要职责:(一)指导研发云互联互通规范的编写,统筹推进研发云互联互通的工作实施,协调解决互联互通中的问题;(二)负责研发云集团级数据需求审批。
3.2 研究院
研究院是研发云互联互通在研发云平台方的实施和运维单位,主要职责:(一)制定研发云平台互联互通规范,按需配合完成互联互通的方案设计、流程及审批、方案实施、网络拉通实施等工作;(二)负责研发云平台总体安全工作,制定平台安全运营管理实施细则并组织落实执行,对互联互通系统接入的安全性进行评估。所有的系统接入、服务接入、数据开放、数据接入工作必须在保证网络安全、数据安全的前提下进行;(三)建立和完善专业化服务团队,负责研发云平台互联互通涉及的研发、体系建设及运营支撑等工作;响应集团内部互联互通需求,经对应级别的审批方审批后进行需求对接工作;(四)制定研发云平台运营维护管理实施细则并组织落实执行,持续建设完善研发云平台安全防护能力,确保研发云平台稳定与数据资产安全;(五)制定研发云互联互通系统安全/运营联动机制,与接入系统共同对发生的安全事件、故障问题进行联动处置,保障研发云平台与互联互通系统的安全稳定运行。
3.3 互联互通对接方
集团各部门、各省公司、专业公司、直属单位,及集团内规模化系统平台是研发云平台互联互通需求方,同时集团各部门、各省公司、专业公司、直属单位5
也是研发云平台互联互通涉及到本组织负责的(组织、项目、人员维度)系统接入、服务接入及数据开放审批方、数据接入需求的主要实施方。主要职责:(一)按照规范提出明确、合规的互联互通需求,包括系统/服务/数据接入及数据开放需求;协助研发云团队完成互联互通运营工作,满足各类互联互通方式在服务能力、安全性等方面的要求,审批涉及到本组织负责的(组织、项目、人员维度)系统和服务接入、数据开放及接入需求;(二)承担接入系统/服务的网信安全责任,遵循研发云安全运营管理实施细则,定期开展安全巡检、安全漏洞扫描、安全审计及风险评估并及时进行加固整治,保障接入系统/服务的安全;(三)承担开放数据的数据安全性,保证从研发云获取、存储、使用数据过程的安全性;保证数据开放需求数据用途与申请时描述的用途一致,若需要超出申请时的用途,需要重新申请,经审批通过后实施变更;(四)承担接入系统/服务的维护职责,遵循研发云运营维护管理实施细则,负责接入系统/服务的可用性日常巡检、变更申请及操作、故障处理,保障接入系统/服务的稳定运行;(五)依据研发云互联互通系统安全/运营联动机制,配合制定接入系统/服务的故障及安全联动应急预案及相关预案的演练与实施,配合接入系统/服务的故障及安全事件联动处置,在规定的时间内及时处置各类异常事件;(六)负责接入系统/服务的用户使用支持,解决用户使用问题,保障用户使用体验。
4 平台互联互通方式
与研发云互联互通的方式包括以下 5 类,外部系统与研发云互联互通可能同时涉及到以下类型的多种:(一)系统接入系统接入是指外部平台与研发云进行集成,提供单点登录能力,实现平台的链接跳转或界面集成等。(二)能力开放
6
能力开放是指研发云平台通过 OpenAPI 及消息事件订阅机制,向外部系统开放平台能力、数据以及平台事件,从而实现外部系统对研发云平台的集成与自动化操作、以及系统间数据交互等场景。(三)数据开放数据开放主要提供研发效能类数据,为需求方提供研发过程管理依据,主要应用场景包括 2 类:
1)系统级数据开放:适用于集团层面为实现某种业务目标,将研发云组织、项目、用户维度相关数据融入集团级规模化平台系统的场景,通常为定制化全集团级别的数据范围;
2)组织级数据开放:各级单位为响应集团各项要求、加强本单位研发过程属地化管理,将研发类数据深度融合本单位研发管理平台的场景;
(四)数据接入数据接入主要应用场景包括 3 类:
1)省专公司将本地部署的测试或部署平台的过程数据同步到研发云,形成完成的研发流程数据视图;
2)特殊项目(例如保密项目)的研发过程数据同步到研发云;
3)系统接入等场景下,第 3 方平台向研发云汇聚该平台的研发过程及指标数据;
(五)服务接入合作方通过标准化方式将自己开发的服务快速接入研发云平台,实现业务功能拓展,丰富研发云平台能力。目前接入的服务类型包括脚手架服务。脚手架服务用于生成项目的初始代码结构,包括目录结构、配置文件和基础代码模板,帮助开发者快速开始开发工作。
4.1 系统接入
系统接入可以有以下 3 种方式:链接跳转:点击链接跳转到对接系统,再登录对接系统。这个只适用于电信外部,账号不与研发云互通的系统的对接;7
单点登录:通过 OpenID Connect 等协议,实现跨平台的身份验证和授权;界面集成:在单点登录的基础上,通过功能页面的集成与整合,实现跨系统间功能的统一呈现,提升用户体验。
4.1.1 单点登录
研发云平台支持天翼认证、云认证及研发云账号密码登录三种方式的单点登录。
1)天翼认证
外部系统与研发云的认证对接基于天翼认证进行对接单点登录,对接规范按照天翼认证认证系统要求
2)云认证
外部系统与研发云的认证对接基于云认证进行对接单点登录,对接规范按照云认证认证系统要求
3)研发云认证
外部系统通过 OIDC 协议与研发云对接认证。
4.1.2 界面集成方式
在单点登录的基础上,提供 2 种集成方式:界面跳转和界面集成
1)界面跳转
用户登录研发云后,点击外部系统跳转菜单跳转进入相应系统。对接单点认证后,与研发云门户产品经理确认系统跳转菜单位置,经过领导确认后排期上线。
2)界面集成
在研发云系统内嵌入外部系统功能页面,用户登录研发云后,在研发云的同一界面下完成相应的功能流程,无跳转体验。
8
页面集成通过 iframe 嵌入的方式集成,研发云与外部系统共同完成集成产品设置,包括菜单设置等。产品确认后研发云门户前端配置应用子系统嵌入外部系统链接。页面集成对于外部系统的要求如下:1. 由外部系统提供对应的前台菜单集合和链接2. 由外部平台提出打开对应菜单链接的其他要求,例如替换链接中的某些参数、新增某些参数/标识等3. 外部平台和研发云页面之间的通信要求,统一使用 postMessage 进行页面之间的通信。具体格式如下:window.postMessage({valueType: "xxx", // 双方约定事件名称data: {}, // 具体参数
}, "*");
4.1.3 访问研发云资源
在用户使用对接系统功能时,可能需要将对接系统的产出,例如代码、制品等资产同步到研发云系统,或者从研发云拉取到对接系统。涉及研发云的资源主要包括:> 代码库> 制品库> 组件广场利用在用户认证授权过程中获取的 Token 访问研发云资源。研发云在生成 access/id token 的时候,将对资源访问的动态密码放到 ID token(JWT)的 payload 里。对接系统接收到 token 后,解析出 token 中的动态密码。后续使用动态密码访问资源系统
- 用户授权后,用户中心根据授权情况去各个资源中心获取动态密码;各资源中心提供获取动态密码的接口;
9
-
用户中心将获取的动态密码编码到 ID Token(JWT 格式)的 payload 中,并返回给对接系统;
-
对接系统对 ID Token 进行解析,取出动态密码,用于后续访问研发云资源;
4)资源中心负责对其颁发的动态密码的访问权限及生命周期的管理。动态密码的初始有效期由各资源中心确定,同时,各个资源中心按自身的产品规划,可提供延长、终止 token 有效期等功能。
4.2 能力开放
4.2.1 OpenAPI
研发云平台提供标准化 OpenAPI 接口,面向客户第三方平台提供的研发云应用能力开放服务,包括用户管理、敏捷能力、共享文档、Wiki、流水线等能力开放。旨在帮助用户调用研发云的应用能力,实现对研发云平台的集成与自动化操作。
4.2.1.1 应用场景
场景(一):打通项目立项及需求同步,避免在两个系统重复操作客户自身的 PMS 系统,计划与研发云对接,打通项目立项,建立项目团队,以及将需求同步到研发云工作项。这个场景可使用研发云提供的项目/用户以及工作项的能力接口去实现相关流程。场景(二):从获取研发云项目文档数据进行考核为检查各项目组的过程文档是否齐备,符合中国电信软件研发规范的要求,客户的 PMS 管理系统计划定期对各项目组的文档进行抽检。抽检的原则是检查项目文档是否包含某些要求的关键字。这个场景可使用研发云的项目/用户,以及文档,wiki 等应用接口实现。场景(三):研发云 CI 能力与客户自有 CD 能力的整合
10
客户自身的综合研发系统,想借用研发云 CI 的能力,实现代码协同和编译构建,然后将构建的成品镜像使用自身的 CD 系统部署到目标环境中。这个场景可使用研发云的 CI 相关的能力开放实现。
4.2.1.2 鉴权实体
第三方平台在调用研发云能力开放接口时,根据不同的接口,有以下 2 种方式:1. 平台级别的认证鉴权。使用预先申请的“外部用户账号”作为接口鉴权实体。外部帐号需由第三方平台向研发云平台申请。第三方平台,如果其业务也与机构相关,应根据机构申请多个外部用户帐号,同时应具备多个外部用户账号的管理能力:可根据每个对话所服务的对象不同而选择正确的外部用户账号作为接口调用的鉴权参数。2. 用户级别的认证鉴权。使用当前登录用户的授权信息去访问相关资源。在用户和研发云 oauth 单点登录过程中,由用户中心统一生成 auth_token并通过 id_token 返回给外部应用。调用接口时,在 header 中添加 auth_token作为鉴权参数。具体流程参考研发云互联互通规范-系统接入技术规范(用户认证和资产授权)。
4.2.1.3 能力开放目录
OpenAPI 可按能力类型和能力归属产品模块两种方式分类。在此按照能力的类型可以划分为机构级、项目非资产级和项目资产级三类(分册将按能力归属产品模块分类详述)。
4.2.2 消息事件订阅
研发云事件能力开放是研发云平台面向各组织提供的消息事件订阅服务。各组织的“ 能力开放管理员”可以设置第三方推送地址,订阅研发云已开放的事件,如流水线配置变更事件、代码库变更事件、安全中心 Sonar 扫描结果通知事件等,并在内部平台进行二次处理后实现对应的消息事件通知。
4.2.2.1 已开放的事件
已开放的应用中心和事件● 用户中心:用户在账号开通、密码重置● 代码中心:代码库变更● 集成中心(流水线):配置变更、 流水线任务执行状态更新、错误日志推送● 安全中心:Sonar 扫描结果● 部署中心:云网集群资源部署对象删除事件12
4.2.2.2 事件订阅权限要求
● 账号需具有“能力开放管理员”角色权限。● 所属组织需加入组织白名单。
4.2.2.3 事件订阅推送方式选择
每个组织仅支持选择一种推送方式: DCOOS(云桥)、HTTPS/HTTP。a)DCOOS(云桥)接入说明支持推送数据至 DCOOS 地址,DCOOS 注册及使用介绍参考“DCOOS(云桥)使用介绍” ,更多问题请咨询云桥平台支撑团队。注意事项:注册 api 时须选择集团 eop,1.0 环境。设置 DCOOS 方式时,除需填入地址外,还需从 DCOOS 平台获取 AppID、 AppKEY 填入后,方可保存设置。b)HTTPS/HTTP 接入说明仅组织级数据订阅支持 HTTPS/HTTP 形式,基于数据安全要求,推荐HTTPS。接口地址开发完成并填入地址后,即可准备接收已订阅数据推送服务。注意,以下情况可能会导致地址无法推送,保存不成功:1.地址对应的服务无法正常访问(网络未放通或服务异常)2.地址对应的服务没有参照研发云消息事件接收开发指南实现
4.2.2.4 事件订阅网络配置
DCOOS:只需订阅方打通与 DCOOS 网络即可;HTTPS/HTTP:需要告知研发云平台支撑人员订阅服务 IP 地址,由研发云放通出口网络策略。同时,订阅方服务侧也需要放通研发云的出口 IP(出口 IP联系研发云支撑团队获取)。
13
4.3 数据开放
研发云数据开放目前面向各单位支持组织级数据订阅(订阅本组织研发过程数据)、系统级数据订阅(面向集团规模化系统提供定制化数据订阅服务)或数据查询接口、取数试算阶段提供人工取数服务。
4.3.1 数据开放范围和开放对象
一、研发云平台数据开放范围:
(一)基于研发云平台的基本对象的维度信息数据:组织、项目、用户等基本信息维度表;(二)基于研发云平台的研发过程效能度量明细数据:代码提交记录、工作项变更记录、部署任务执行记录、流水线构建记录等明细表;(三)基于研发云平台的效能度量汇总模型数据:项目、用户维度汇总指标等;(四)基于研发云平台的研发成果数据:专利等相关数据;注意:(一)数据开放不涉及源代码文件、制品等内容,由相应中心负责该资产的开放范围、开放方式及权限控制等;(二)研发云除特殊情况外,不对外开放从其他第三方平台获取的数据。
二、研发云平台数据开放对象:
(一)对象一:集团及下属组织:原则上仅面向集团本部各部门及中心、省公司、直属专业公司提供数据开放,范围以外的下级组织需向上级组织沟通获取研发云数据。原则上各组织仅可订阅归属为本组织相关研发云数据。若存在超出归属为本组织的数据需求,需向数据范围对应级别的审批方提出申请,审批通过后开放。(二)对象二:集团内规模化的平台系统:原则上,仅面向集团统筹建设的规模化平台系统开放数据,如原子能力平台、人才云等。研发云经数据范围对应级别的审批方(见 5.3.2)审批通过后按需开放需求数据。
14
4.3.2 数据开放形式
按需支持 3 种数据开放形式:(一)研发云提供数据查询接口方式:适用于单次查询结果量不超过 50 条、单次应答传输数据量小于 1MB 的场景。视具体情况可以通过以下两种方式接入:1.通过研发云能力开放-应用能力开放提供,按照研发云应用能力开放专区指引接入2.通过 DCOOS 提供,按照 DCOOS 能力开放指引接入
(二)需求方进行研发云数据订阅方式:对于需求方需要获取数据进行二次开发、个性化数据分析,且需要的数据量较大,当数据变更时需要及时更新的场景,可以采用数据订阅方式。同时,研发云可以提供 Java SDK,便于需求方调用,实现数据自动入库。需求方可以通过以下 3 种方式订阅数据:1.DCOOS 方式当需求方具备接入 DCOOS 网络条件时,提供数据接收接口并注册到 DCOOS,研发云调用需求方 DCOOS 接口推送数据。2.HTTP/HTTPS 方式当需求方不具备接入 DCOOS 网络条件时,可以提供基于 Http/https 的数据接收接口,研发云调用需求方接口推送数据。3.Kafka 方式研发云开放 Kafka 集群,为需求方开通专属消息队列的订阅权限,需求方可按需要消费消息获取所需要的数据。
(三)人工取数方式对于暂时无法通过方式一、方式二获取,且有迫切需求的,需求方可按流程向数据范围对应级别的审批方提出数据需求申请(见 5.3.2),经审批后,由研发云团队人工的方式实施取数。
15
对于同一需求,需要多次取数的情况,首次提交申请时需说明取数频率周期。后续每次取数需提申请。若人工取数方式进入常态化阶段,需考虑变更为自动化取数方式,以减少不必要的人力资源消耗。
4.4 数据接入
数据接入适用于集团在推进系统数据融通及研发类数据深度融合研发云平台的场景,旨在为数据接入研发云数据中台提供统一的标准与整体要求,确保数据的规范性、一致性与可管理性。例如统一技术栈 Apaas 数据,MSS 相关数据,因特殊原因限制无法在研发云平台上开展活动涉及的相关数据,例如独立部署功能所产生的数据。
4.4.1 接入数据模型
对应研发云数据中台的汇总模型和明细模型,与研发云的实体关联的数据,如项目、人员、组织维度的汇总数据以及明细数据。
4.4.2 接入方式
研发云平台提供统一的能力开放接口,以 OpenAPI 方式给外部系统使用。 OpenAPI 接入技术要求详见《5 研发云互联互通规范-能力开放技术规范(OpenAPI 接口)》。
4.4.3 接口规范
外部系统数据(包括研发活动指标和数据)可根据需要接入研发云。数据接入研发云时,根据对接的内部系统可细分,主要差异在于接口格式。a. 通过消息中心接入b. 通过其他中心接入
16
4.4.3.1 通过消息中心接入
部署数据等的接入是通过消息中心实现的。研发云平台定义了统一的 CloudEvents 格式的消息数据规范。外部系统基于统一数据规范,调用研发云数据推送能力开放接口(OpenAPI),向研发云推送相关业务数据。数据接收流程涉及 3 类系统级对象:外部系统数据发送方(以下简称:发送方),研发云消息中心(以下简称:消息中心),研发云数据接收方(以下简称:接收方)。消息中心,作为研发云接收外部系统消息数据的统一入口,负责数据类型注册管理、数据格式校验、数据接收、暂存、分发。消息中心对外提供 2 个标准的数据推送能力开放接口:单消息推送和批量消息推送。接口通过研发云能力开放专区对外提供,并同时注册到 DCOOS。发送方,根据自身系统与研发云的网络联通条件,选择订阅研发云能力开放专区或者 DCOOS 的数据推送接口(订阅接口具体流程,详见研发云能力开放专区或者 DCOOS 文档),与接收方预先协商消息数据格式,调用消息中心开放接口,实时推送或者批量推送数据,当调用接口失败(即,HTTP 状态码非
200),要负责重新推送,以保证数据能最终推送成功。
接收方,负责处理能力开放接口的接入数据,或向消息中心注册需要接收的消息数据类型,并订阅和处理消息数据。
4.4.3.2 通过其它中心接入
例如测试数据的接入。详细参见《5 研发云互联互通规范-能力开放技术规范(OpenAPI 接口)》。
4.5 服务接入
17
合作方通过标准化方式将自己开发的服务快速接入研发云平台,实现业务功能拓展,丰富研发云平台能力。目前支持的主要内容是脚手架接入。脚手架服务从模板快速灵活的生成各类搭配的项目初始化代码库。
5 互联互通管理流程
外部系统与研发云互联互通过程中,涉及到接入、账号密码申请等管理流程,以下章节描述各种互联互通方式相关的管理流程。所有流程均使用研发云问需系统进行。
5.1 系统接入
外部系统接入研发云,需要完成系统接入审批流程和系统接入上线流程。
5.1.1 系统接入审批流程
外部系统接入研发云前,需要提交相关资料,进行接入审批,审批完成后,获取用于接入联调和测试的 client id、client secret 等信息。
流程描述:
18
- 外部系统接口人发起审批流程,需要填报接入研发云所需的相关信息及附上相关资料:
a) 外部系统的介绍(功能、使用、界面)
b) 外部系统使用前端技术
c) 外部系统维护所需的架构设计文档,包括部署架构、网络交互架构、服务清单等
d) 拟采用的认证方式(天翼认证、云认证、研发云认证)
e) 其它相关信息和资料
i. 外部系统接口信息(包括 URL,IP 端口等)ii. 按需提供交互架构、数据等设计方案、数据库初始化/升级等脚本2. 产品经理接收到申请后,组织开发团队完成初步的系统接入设计,包括以下内容:
a) 系统入口
b) 菜单、界面布局等
c) 按需完成系统交互架构、数据交互情况、服务部署规划等设计说明
- 产品经理完成设计后,提交运维和安全团队会审4. 运维和安全团队根据系统集成需求和设计进行初审,评估可行性和可能存在的问题,会审后提交项目经理审批5. 项目经理审批后,提交用户中心(菜单)与运维团队(网络)进行配置6. 用户中心配置接入生产系统所需的 client id/client secret,通过邮件点对点发送给外部系统联系人;运维团队进行网络配置(通过沟通群直接与用户沟通验证);7. 返回流程审批及处理结果
5.1.2 系统接入上线流程
外部系统完成接入的开发联调后,在正式接入生产系统前需要提交上线申请。
19
流程:1. 外部系统接口人提交上线要求的相关资料,包括:
a) 系统漏洞扫描、渗透测试报告
b) 安全保密协议、服务保障 SLA 协议等协议签订/盖章材料
c) 安全事件应急处理预案与安全运维联系人信息
d) 数据安全保护措施和保护能力评估报告,涉及重要和核心模块数据交互的接入方,还应提供权威的第三方机构的安全测评报告
e) 接入研发云系统的测试报告
f) 网络放通所需信息(对端系统 IP 端口等)
- 产品经理进行资料完备性审核后,提交运维团队和安全团队进行审核3. 运维团队和安全团队进行安全性检查(同一流程环节即可,没有先后关系)后,提交项目经理审批4. 项目经理审批后,提交用户中心(菜单)与运维团队(网络)进行配置5. 用户中心配置接入生产系统所需的 client id/client secret,通过邮件点对点发送给外部系统联系人;运维团队进行网络配置(通过沟通群直接与用户沟通验证);6. 返回流程审批及处理结果
5.2 能力开放
5.2.1 OpenAPI
20
OpenAPI 由新增和使用两个场景形成完整的管理流程。
5.2.1.1 新增 OpenAPI
现有 OpenAPI 无法满足需求方时,可参考新增 OpenAPI 的整体开发流程实现新增 OpenAPI 的及时上线1. 需求方可向研发云产品团队提出 OpenAPI 新增需求;2. 研发云产品团队评估需求是否纳入规划;a. 若评估通过将纳入规划b. 若评估不通过告知需求方原因3. 研发云开发团队将纳入规划的 OpenAPI 需求排期开发;4. 研发云团队完成上线后告知需求方已实现。
5.2.1.2 申请使用 OpenAPI
现有 OpenAPI 可满足需求时,参考申请 OpenAPI 使用流程进行调用1. 需求方所在组织的能力开放管理员通过能力开放页面发起申请应用能力使用评审2. 研发云运营团队审批评审a. 若评审通过后将为需求方开通账号与权限
21
b. 若不通过将说明原因告知需求方3. 需求方调用 OpenAPI
5.2.2 消息事件订阅
消息事件订阅时,需求方需查看该事件是否已开放。已开放事件,需求方具有权限后即可订阅;未开放事件,需求方需提出需求申请,研发云团队进行需求评估。
5.2.2.1 事件已开放
- 需求方可根据指引查看是否具有以下订阅权限;a. 能力开放管理员b. 所在组织在组织白名单列表2. 需求方根据需求订阅对应事件,并进行测试、二次开发和集成。
5.2.2.2 事件未开放
- 事件未开放时,需求方可由单位接口人在研发云问需系统提交事件需求;
22
- 研发云团队将评估该需求是否实现;a. 若实现,研发云团队将该需求排期、开发、测试、上线。上线后将在问需系统向问需提出人同步上线情况b. 若不实现,将在问需系统说明原因告知需求提交人3. 需求方调用新上线的消息事件。
5.3 数据开放
5.3.1 数据开放流程
数据开放流程按数据开放形式分不同流程。
5.3.1.1 数据查询接口方式
需求方需将数据需求描述清晰(具体字段、数据权限范围等)向数据范围对应级别审批方申请数据需求,经审批通过后开展数据对接工作。1. 研发云应用能力开放
-
研发云团队将数据接口发布到研发云应用能力开放专区;
-
需求方按照应用能力开放专区指引申请开通接口访问。
- DCOOS 能力开放
-
研发云团队将数据接口注册到 DCOOS;
-
需求方在 DCOOS 提出订购数据接口的申请;
-
研发云团队在 DCOOS 批准订购申请;
-
需求方接入 DCOOS 进行调测。
5.3.1.2 数据订阅方式
面向不同数据开放对象及场景,数据订阅流程分别为:
1.组织级数据订阅场景:面向集团各部门、各省公司、专业公司、直属单位提供本组织研发云数据订阅,该场景需求方需使用“组织级数据订阅管理”应用进行数据订阅:
-
数据准备:研发云按各单位提出的问需准备可订阅数据表清单,在研发云能力开放专区发布数据开放表;
-
数据订阅管理应用白名单开通申请:数据订阅管理应用初次使用需开通白名单访问,数据需求组织向研发云邮件申请开通“数据订阅管理” 白名单。研发云审批后开通;
-
角色开通:数据需求组织在企业管理后台为本组织数据订阅实施人员开通本组织“ 能力开放管理员”角色;
-
设置订阅方式:数据需求组织按需选择数据订阅推送方式,DCOOS、 HTTPS/HTTP 或 Kafka;
-
订阅数据:数据订阅推送方式成功设置后,数据需求组织按需选择要订阅的数据表,开启推送。订阅数据过程中,如遇问题应及时响应并关闭推送。若要订阅超出本组织负责的数据范围,需要提出申请,通过后开通。
2.系统级数据订阅场景:面向集团内规模化的平台系统提供个性化跨组织数据订阅,该场景需求方需使用“系统级数据订阅管理”应用进行数据订阅:
-
需求系统对接人需将数据需求描述清晰(具体字段、数据权限范围等)提出申请,由数据范围对应级别的审批方审批;
-
需求审批通过后,研发云根据数据需求准备数据表的开发;
-
需求系统选择数据订阅方式:DCOOS、HTTPS/HTTP 或 Kafka,做相关开发准备工作;
-
订阅数据:需求系统做好数据订阅接收准备,双方测试联调后,正式接收数据推送。订阅数据过程中,如遇问题应及时响应并关闭推送。
5.3.1.3 人工取数方式
- 需求方对接人明确数据需求:具体字段、数据权限范围等;
24
-
需求方对接人提出申请,由数据范围对应级别的审批方审批;
-
需求审批通过后由研发云实施,确保数据安全的情况下,数据文件加密的方式交付需求方。
5.3.2 数据范围级别及审批原则
数据开放需求均需与集团层面现有业务场景强关联,有明确的集团层面业务对接人,具体审批原则:
5.4 数据接入
25
本规范旨在明确数据接入的全过程管理要求,确保数据接入工作的安全性、合规性和高效性。流程涵盖需求提出、对接方式确定、审批、实施、网络申请、账号申请、上线、监控与维护等环节。
5.4.1 数据接入流程
- 需求提出
1.1 数据需求:
-
数据接入需求方提出数据接入需求,明确数据来源、数据类型、数据量、数据频率等。
-
数据接入需求方提交需求文档,包括需求背景、需求内容、需求预期效果等。
1.2. 确定对接方式
-
数据接入方与研发云根据需求文档,确定数据接入的对接方式,如消息中心
-
数据接入方与研发云制定对接方案,包括对接频率、数据格式、数据校验规则等
1.3. 数据安全与合规性评估
-
在确定需求和接方式的同时,数据接入方与研发云进行数据安全与合规性评估
-
评估内容包括数据加密、数据脱敏、数据访问控制、数据隐私保护、数据使用许可、数据跨境传输等。
- 审批
-
数据接入需求方提交对接需求及方案,由研发云运营小组、数据安全小组、数据中台及集团科创研发管理处进行审批。
-
审批内容包括对接方式的可行性、数据安全、数据合规性等。
- 实施
3.1 开发
27
-
审批通过后,数据接入需求方与研发云开始实施数据接入。
-
实施内容包括开发对接接口、配置网络环境、测试对接效果等。
3.2 网络申请
-
根据对接方案,数据接入方与研发云申请必要的网络资源。
-
网络申请内容包括 IP 地址、端口、网络带宽等。
3.3. 账号申请
-
根据对接方案,数据接入方与研发云申请必要的账号资源。
-
账号申请内容包括账号类型、账号权限、账号有效期等。
- 数据质量验证评估
-
在实施和上线前,数据接入方配合研发云数据中台进行最终数据质量的验证及评估。
-
评估内容包括数据完整性、数据准确性、数据一致性等。
5 上线运营
5.1 上线
-
实施完成后,数据接入方与研发云进行数据接入的上线。
-
上线内容包括部署对接接口、配置网络环境、测试对接效果等。
5.2. 监控
-
在上线后,研发云进行数据接入的监控。
-
监控内容包括数据接入频率、数据接入量、数据接入错误率等。
5.3. 维护
- 在上线后,数据接入方及研发云共同进行数据接入的维护。
28
- 维护内容包括数据接入故障处理、数据接入性能优化、数据接入版本升级等。
6 下线
- 下线流程经需求方提出,经集团审批后执行,包含数据归档或删除,网络/账号资源、服务等相关资源回收。
5.5 服务接入
5.5.1 脚手架接入流程
各单位的脚手架服务需按照以下标准流程进行接入:
1)申请接入
■ 各单位向研发云平台提出脚手架集成开发与接入申请(研发云问需)■ 审核通过后,研发单位与相关开发人员需与研发云签订数据安全协议
2)代码开发
■ 研发人员需遵循《6 研发云互联互通规范-服务接入技术规范(脚手架服务)》进行代码开发■ 开发后并在本地完成自测,并进行安全评估
3)联调测试
■ 研发单位向研发云申请进行集成测试,以及产品安全相关评估报告(产品无中高危漏洞与安全风险)■ 经研发云评估集成产品符合准入要求后,由研发云配合分配测试部署资源、指导协助完成部署与联调测试
29
4)上线生产
■ 产品功能集成测试通过后,由研发单位提出生产上线申请,申请材料需同步提交运维所需的文档材料(部署架构、服务清单等)、更新相关安全评估报告、签订产品运营服务保障协议
5)更新维护
■ 产品上线生产后,由研发单位与研发云按照约定的分工职责和质量要求开展日常运营与迭代升级工作
5.6 安全运营
5.6.1 重大安全事件应急处置流程
重大安全事件是指已经发生的严重影响业务、对利益及声誉构成较严重威胁和影响的安全事件。主要包括:重要基础设施遭受攻击导致服务中断,设备被渗透控制,恶意程序传播,用户个人信息以及企业核心数据等批量泄露,以及其他严重安全事件。重大安全事件应按照以下步骤开展应急处置工作:I. 接入方监测到接入方系统或研发云平台发现重大安全事件后,应立即按照本单位制定应急预案进入应急状态,根据“边处置、边报告” 的原则,启动应急处置工作,并及时通过工单、电话、短信、邮件等方式向研发云报告;研发云平台监测到研发云平台或接入方系统发现重大安全事件后,研判重大安全事件影响范围,针对可能遭受影响接入方系统,应及时通过工单、电话、短信、邮件等方式告知相关接入方。II. 接入方和研发云双方应按照应急预案,对重大安全事件的类型、特点和原因进行分析研判,采取控制攻击源、过滤攻击流量、修补漏洞、查杀病毒、关闭端口、启用备份数据、暂时关闭相关系统等应急处置措施,以及防止发生次生、衍生事件的必要措施。对于大规模用户信息泄露事件,还应当及时告知受影响的用户,并告知用户减轻危害的措施。
30
III.重大安全事件应急处置期间,接入方和研发云双方应及时沟通重大安全事件处置进展情况。IV. 重大安全事件应急处置结束后,接入方应将应急处置报告发给研发云报备。
5.6.2 重大安全风险处置流程
重大安全风险是指有可能引发接入方系统或研发云平台发生重大安全事件的风险隐患。重大安全风险主要包括:可能被利用的网络安全重大漏洞、开源组件或平台中可能存在的仆后门程序”、监测到的可能攻击或被植入病毒木马、重大威胁情报、不受控的软硬件供应商,以及其他可能导致重大安全事件的风险隐患。重大安全风险应按照以下步骤开展处置工作:I. 研发云对集团公司、研究院主管部门通报、第三方公司发布的重大风险预警,迅速组织评估危害程度和影响范围,按照应急预案开展处置,及时组织消除研发云平台安全风险,并研判重大安全风险影响范围,针对可能遭受影响接入方系统,及时向相关接入方反馈风险排查结果、整改计划、整改处置结果。II. 接入方对集团公司、研究院主管部门、研发云通报、第三方公司发布的重大风险预警,应按照应急预案开展处置,及时组织消除接入方系统安全风险,并及时向研发云报告风险排查结果、整改计划、整改处置结果。
6 网络对接方案
方案旨在解决研发单位现有开发测试资源接入研发云的问题,实现存量项目研发基础设施环境与研发云 CD 部署的全面对接。研发基础设施环境涵盖研发单位的开发、 测试及生产部署环境。依据各研发单位部署资源的网络条件,提供了以下几种网络打通方案供选择。研发单位资源网络环境主要分为三种类型,第一种类型是研发单位侧所有主机都可以直接访问 CN2-1124 网络;第二种类型是研发单位侧有一台主机可以同
31
时接入 CN2-1124 网络和本地内网;第三种类型是不能直接访问 CN2-1124,但可以访问互联网。对于第一种网络,研发单位的主机可以直接通过 CN2-1124 网络访问研发云平台,无需额外网络施工。对于第二种网络,需要在那台同时接入 CN 2-1124 网络和本地网络的主机上安装 Nginx 代理,通过代理接入研发云。对 于第三种网络类型,需在研发单位侧部署 SASE 网关,通过 SASE 网关叠加互联网实现对研发云平台的访问。
6.1 通过 CN2-1124 直通
采用本方案的前提条件:研发单位的开发、测试、生产部署环境能访问 CN2- 1124VPN 地址。
研发单位侧主机直接访问研发云平台的 1124VPN 地址。
6.2 通过 CN2-1124 中间代理
采用本方案的前提条件:研发单位有一台服务器可同时接入 CN2-1124VPN 和本地内网环境
研发单位侧主机通过 CN2-1124 Nginx 代理机接入研发云(代理机需研发单位提供域名证书并在各环境统一做域名解析,避免终端请求报证书错误以及自行配置 hosts 解析的问题)。
6.3 通过 SASE 打通
采用本方案的前提条件:研发单位的开发、测试、生产部署环境能访问公网当研发单位的主机不能直接访问研发云 1124VPN 地址时,采用 SASE 打通方案, SASE 打通 分为单向、双向、二级代理三种类型,其中双向、二级代理两种方式是在单向基础上额外再加一个 Nginx 实现研发云和研发单位资源的反代转发。
6.3.1 SASE 单向打通
主要功能单向打通即可,可用于门户访问、代码/制品拉取、部署/测试代理安装等功能。研发单位资源需要配置路由策略将访问研发云(10.158.231.0/26)的流量全部转发到 SASE 代理节点(建议直接在每个环境的出口网关上配置,避免每台主机添加路由策略)
6.3.2 SASE 双向打通
在单向基础上增加实现流水线专用节点接入、本地镜像同步推送(需要研发云服务端访问用 户侧主机资源)。在 SASE 单向打通的基础上,在 SASE 客户端所在的同一台主机上部署 nginx 代理 ,代理研发单位侧的主机端口,实现反向访问。
6.3.3 SASE 二级代理开放
对于研发单位资源分散的部署环境(部署环境和 SASE 客户端不在同一网络),在 SASE 客户端节点部署 nginx 代理,代理研发云平台开放给研发单位访问(必须通过白名单控制访问,研发云是内网系统,不允许直接公网代理开放访问。二级代理需研发单位提供域名证书并在各环境统一做域名解析,避免终端请求报证书错误以及自行配置 hosts 解析的问题)
7 互联互通安全要求
研发云平台系统间交互集成,接入方系统需满足以下安全管理要求。
7.1 基本安全要求
34
-
接入方应加强接入系统安全开发与运维工作,系统开发遵循安全开发规范,持续开展 SCA、SAST、DAST 等安全测试,定期扫描组件漏洞,及时修复或升级漏洞
-
接入方应提供接入系统的系统代码安全扫描、漏洞扫描、渗透测试报告,并交予研发云平台(结论部分)审核存档,对于相关报告中涉及的漏洞或安全风险应完成整改后再开展对接工作
-
在接入系统正常运营服务期间,接入方应对系统新增发现的安全漏洞及时修复
-
接入方应定期以及在大的系统升级后对系统进行全面安全评估,接入方对提供的评估材料和结论的真实性负责
-
接入方应具备日志审计与监控能力,记录所有系统操作,对异常事件实时监控与告警,保留日志至少 6 个月,并定期开展审计工作
-
接入方与研发云平台双方需遵守集团、研究院和研发云制定的数据安全制度规程,加强身份认证与授权管理,确保数据在采集、传输、存储等全生命周期中的安全管理和防护
-
接入方与研发云平台双方均应具备相应的安全事件应急处置预案,若发生系统被攻破、数据资产泄露、网络跳转攻击等安全事件时应第一时间通知对方安全联系人,进行必要的安全防护处置动作
-
在发生安全事故后,接入方与研发云平台双方应共同评估事故原因,确定责任归属,并据此采取相应的补救措施和责任追究
7.2 API 对接安全要求
-
接入方应提供 API 技术安全相关文档,研发云基于文档,针对 API 进行渗透测试和漏洞验证
-
接入方系统与研发云平台系统间交互接口应使用传输加密和安全的通信协议。数据传输必须采用 TLS 1.3 及以上协议加密,敏感数据(如用户凭证、代码仓库密钥)需额外应用应用层加密(如 AES-256)。API 必须鉴权
35
- 接入方系统应采取输入验证与输出过滤措施,防范 SQL 注入、XSS 等漏洞;并使用 OpenAPI 规范定义接口,避免暴露敏感信息
7.3 页面集成安全要求
-
接入方系统功能页面通过 iframe 嵌入研发云,接入方页面须使用https协议与公网可信证书,避免影响研发云平台用户体验(浏览器会弹出安全风险提醒)
-
研发云平台配置 CSP 头,严格限制 iframe 来源 ,在 iframe 标签中添加 sandbox 属性,限制其 XSS 执行能力
-
研发云平台使用 CORS(跨域资源共享)严格限制来源域 , 禁止配置Access-Control-Allow-0rigin:*,并对敏感操作(如文件上传)实施预检请求校验
7.4 链接跳转安全要求
-
跳转合法性验证:所有外部链接跳转需实施白名单机制,禁止动态拼接未经验证的 URL,防范开放重定向(0pen Redirect)攻击
-
来源可信度验证: 服务器端使用 HTTP 协议头 Referrer Policy 和CSP(Content Security Policy)限制跳转来源域, 并通过数字签名(如JWT)验证跳转请求的完整性
-
用户风险提示:跳转至外部系统前,需明确提示用户目标域名的变更,并提供风险确认机制(如二次弹窗验证)
7.5 单点登录(SS0)安全要求
-
身份联合审计: 记录 SS0 全流程日志,支持跨系统溯源审计,确保身份行为可追踪
-
防钓鱼与令牌劫持: 强制启用 HTTPS,禁用明文传输;针对移动端场景需防范通过恶意 App 窃取令牌
36
7.6 功能交互安全要求
-
接入方应明确数据交互范围、应用场景、交互方式,涉及数据采集应遵循合法必要、最小必要原则,涉及数据交互的应与研发云签订数据安全责任协议
-
接入方应提供数据安全保护措施和保护能力评估报告,涉及重要和核心模块数据交互的接入方,还应提供权威的第三方机构的安全测评报告。
-
涉及重要和核心模块数据采集的接入方,应具备数据全生命周期各环节的保护措施,落实数据安全五防,数安保护等级不低于研发云的数安等级要求
-
接入系统因自身安全问题导致研发云平台用户数据或其它资产数据泄露应承担相应安全责任
7.7 其他安全要求
按照网信安相关要求,研发云平台与接入方系统之间禁止批量同步以下数据:
-
用户信息;
-
项目信息;
-
用户角色和权限等信息。
8 附件
8.1 数据开放和接入流程指引模板
8.1.1 https://docs.srdcloud.cn/docs/iLFuvmdSldTmjTGE/ 《数据中台数据需求接入方流程 SOP-2025》
8.1.2 https://docs.srdcloud.cn/docs/UDnVSIxgKT0CHhgA/ 《数据开放-系统级数据开放数据需求申请模板》
37
8.1.3 https://docs.srdcloud.cn/docs/m4kMLgKM6ZUOdpqD/ 《系统级数据开放-需求方接口人处理流程指引》
8.1.4 https://docs.srdcloud.cn/docs/zazLsJ7n44UtQabm/ 《数据开放-人工取数需求申请模板》
8.1.5 https://docs.srdcloud.cn/docs/9lPJ96tnp9Vv08oP/ 《数据开放-组织级数据开放数据需求申请模板》
8.2 能力开放-OpenAPI 申请操作指引
https://docs.srdcloud.cn/docs/VMAPVjDa8BFpZGqg/《附件 8.2 能力开放-OpenAPI 申请操作指引》
8.3 能力开放-“ 消息事件订阅”操作指引
https://docs.srdcloud.cn/docs/2wAlXK6ZENTW9gAP/ 《附件 8.3 “消息事件订阅”操作指引》
8.4 集成方单位数据安全承诺书模板
https://docs.srdcloud.cn/docx/rp3OVnoPaESoYBAm/《附件 8.4 关联方单位数据安全承诺书(样例).docx》
8.5 集成方个人数据安全承诺书模板
https://docs.srdcloud.cn/file/gXqmeyDpPvCrJ8qo/ 《附件 8.5:关联方人员数据安全承诺书(样例).docx》
8.6 系统接入-第三方应用接入申请表
附件 8.6:系统接入-第三方应用接入申请表
38