华为云CodeArts Req需求管理对接使用完全指南
一、CodeArts Req产品定位与核心能力
华为云CodeArts Req（原ProjectMan）是华为多年研发实践沉淀的需求管理与团队协作服务，为敏捷开发团队提供简单高效的团队协作能力，包含多项目管理、敏捷Scrum、需求管理、缺陷跟踪、文档托管、统计分析、工时管理等核心功能。该系统内置多种开箱即用的场景化需求模型和对象类型，可支撑IPD、DevOps、精益看板等多种研发模式，还包含跨项目协同、基线与变更管理、自定义报表、Wiki在线协作、文档管理等功能。
CodeArts Req预置了五种项目模板：IPD-系统设备类模板、IPD-独立软件类模板、IPD-自运营软件/云服务类模板、Scrum项目模板、看板项目模板，满足从传统硬件研发到云原生软件交付的全场景需求。在权限管理层面，服务采用IAM与项目级双重权限体系，云服务级权限通过统一身份认证服务管理，项目级权限则在项目内按角色精细化设置。
需要先登录华为云控制台，点击：华为云控制台，还没有账号，点击：注册并关联，已有账号点击：登录后关联
二、服务开通与项目快速启动
CodeArts Req需求管理服务需要配合CodeArts其他服务使用，开通任意CodeArts套餐即可获得需求管理能力。用户进入需求管理控制台后，页面会提示前往购买CodeArts套餐，单击购买按钮进入购买开通页面，根据需要选择相应套餐完成开通。服务开通后，访问CodeArts Req服务首页，即可开始创建项目和管理需求。
创建项目时可根据研发模式选择合适的模板。Scrum项目适合采用敏捷迭代开发的团队，看板项目适合轻量级、灵活的任务协同场景，IPD系列模板则面向需要严格流程管控的大型产品研发。预置的示例项目会自动生成样例模板，供用户参考和使用，同时示例项目中预置的示例工作项、代码可供用户直接使用。
在IPD系统设备类项目中新建研发需求时，需要填写标题、描述、提出人、当前责任人、优先级、发布计划、迭代、计划时间、领域等参数。系统支持附件上传，单个研发需求的附件数量最多100个，总容量为500MB。需求新建成功后，系统自动通过邮件和站内信通知当前责任人、提出人和抄送人。
CodeArts Req还提供了跨项目协同能力。用户可以将当前项目的研发需求协同下发给下游项目，最多可下发给10个项目。协同下发后，下游项目负责人可以接收、拒绝或转交该需求，实现跨团队的需求流转与闭环管理。
三、基于ROMA Connect连接器的可视化对接
ROMA Connect是华为云的应用与数据集成平台，提供CodeArts Req连接器，用户无需编写代码即可实现与需求管理服务的对接集成。使用连接器前需要先开通需求管理服务。在ROMA Connect控制台的左侧导航栏选择“连接器”，单击“新建连接”，选择“需求管理”连接器。在弹窗中配置连接器信息，需要填写连接名称、描述、Access Key和Secret Access Key，AK/SK可以从已有的credentials.csv文件中获取。
CodeArts Req连接器支持丰富的预置动作，包括查询迭代下工作项状态的统计数据、查询项目状态列表、更新项目的领域、查询项目的领域列表、删除项目的模块、取消领域与项目的关联关系、查询项目的模块列表、查看迭代历史记录、查询当前工作项已经关联的代码提交记录、查询Scrum项目的工作项流转配置、获取项目概览、获取需求统计信息、查询项目下所有工作项的历史记录、获取bug统计信息、更新工作项、批量删除工作项、创建工作项、查询项目的工作项、高级查询工作项、查询工作项详情、获取子工作项、按用户查询工时、获取当前用户信息、查看迭代详情、获取指定项目的迭代列表、创建项目、更新Scrum项目迭代、删除项目迭代、创建Scrum项目迭代、检查项目名称是否存在、获取指定项目的评论列表、添加项目成员、查询项目列表、查询缺陷密度、查询Scrum工作项自定义字段等数十种动作。
通过ROMA Connect连接器，用户可以搭建低代码集成流程，将CodeArts Req与其他系统自动对接。例如可以配置定时触发从CodeArts Req获取未解决缺陷单并通过邮箱推送到个人，实现研发数据的主动通知。
四、REST API深度集成与多语言SDK开发
对于需要深度定制集成的场景，CodeArts Req提供了完整的REST API接口。用户可以使用API对需求管理进行相关操作，如执行查询任务、创建工作项、管理迭代等。API的调用需要先获取IAM用户Token作为X-Auth-Token请求头进行身份认证。
终端节点（Endpoint）信息由服务名、Region ID、外部域名三部分组成，格式为service_name.region0_id.external_global_domain_name。如果Endpoint不能直接访问，需要获取API网关浮动IP地址并进行hosts文件配置。
以下以Python语言为例，演示如何调用CodeArts Req API查询项目列表：
import requests
import json
# IAM认证获取Token
iam_url = \"https://iam.myhuaweicloud.com/v3/auth/tokens\"
iam_payload = {
\"auth\": {
\"identity\": {
\"methods\": [\"password\"],
\"password\": {
\"user\": {
\"name\": \"your_username\",
\"password\": \"your_password\",
\"domain\": {\"name\": \"your_domain_name\"}
}
}
},
\"scope\": {\"project\": {\"name\": \"cn-north-4\"}}
}
}
response = requests.post(iam_url, json=iam_payload)
token = response.headers.get(\"X-Subject-Token\")
# 调用CodeArts Req API查询项目列表
api_url = \"https://projectman-ext.cn-north-4.myhuaweicloud.com/v4/projects\"
headers = {\"X-Auth-Token\": token, \"Content-Type\": \"application/json\"}
response = requests.get(api_url, headers=headers)
projects = response.json()
print(json.dumps(projects, indent=2, ensure_ascii=False))
查询指定项目成员列表的API接口为GET /v4/projects/{project_id}/members，其中project_id是DevCloud项目的32位id。分页参数支持offset偏移量和limit每页数量，limit最大为100条。响应返回members数组和total总数，每个成员包含domain_id、user_id、role_id等信息，role_id表示成员角色：1为项目创建者、3为项目经理、4为开发人员、5为测试经理、6为测试人员、7为参与者、8为浏览者、9为运维经理。
以下是Java SDK调用示例，展示如何创建CodeArts Req连接并查询项目信息：
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.projectman.v4.ProjectManClient;
import com.huaweicloud.sdk.projectman.v4.model.*;
public class CodeArtsReqDemo {
public static void main(String[] args) {
String ak = \"your_access_key\";
String sk = \"your_secret_key\";
BasicCredentials auth = new BasicCredentials()
.withAk(ak).withSk(sk);
ProjectManClient client = ProjectManClient.newBuilder()
.withCredential(auth)
.withRegion(\"cn-north-4\")
.build();
ListProjectsRequest request = new ListProjectsRequest();
try {
ListProjectsResponse response = client.listProjects(request);
System.out.println(response.toString());
} catch (ServiceResponseException e) {
System.err.println(\"Error code: \" + e.getHttpStatusCode());
System.err.println(\"Error message: \" + e.getErrorMsg());
}
}
}
五、扩展插件开发与流水线集成
CodeArts提供了插件扩展能力，用户可以使用标准的前端技术栈（如HTML、JavaScript、CSS）开发UI插件，同时通过CodeArts提供的REST API Client实现插件与各服务的交互。开发好的插件可以上传到CodeArts中，生成可访问的html页面，通过“扩展插件”服务即可安装使用。
插件平台支持低代码化生成前端页面，拖拽组件可生成可视化表单，打通流水线上下文数据，减少插件开发成本。平台默认提供了单行输入、数字、下拉单选、下拉多选、单选框、开关、多行输入、Metrics等多款控件。CodeArts还提供了codearts-plugin-cli用于打包UI扩展，开发者可以将编写的插件代码通过命令行工具打包并上传到插件市场。
服务扩展点是CodeArts连接第三方服务的能力扩展机制。当CodeArts中的任务需要连接到远程第三方服务进行数据操作时，例如连接第三方GitHub仓库获取项目源码、连接第三方Jenkins服务执行Jenkins任务等，可以通过新建扩展点来实现与相应服务的连接。开发者可以利用官方工具镜像进行插件开发，自行实现业务逻辑，当前支持Shell、Node.js、Python、Java等多种主流语言的业务脚本编写。
流水线插件开发流程为：登录CodeArts首页，单击“服务 > 扩展插件”进入流水线插件管理平台，单击“搭建流水线插件”开始注册插件，填写插件基本信息并配置执行逻辑，完成插件开发后发布到扩展插件服务中供团队成员使用。
六、Jira与CodeArts Req数据双向同步方案
在企业迁移或混合使用场景中，Jira与CodeArts Req之间的数据双向同步是一个常见的需求。华为云CodeArts Link提供了完整的同步方案，帮助企业实现不同业务系统间的高效协同工作。
CodeArts Link内置了多个同步模板，主要包括三种同步场景。第一，Jira新增Issue同步至CodeArts Req，将Jira中新创建的Issue自动同步到CodeArts Req中，减少手动输入，提高数据录入效率和准确性。操作步骤包括登录CodeArts Link控制台，进入资产目录搜索找到“Jira新增Issue同步至CodeArtsReq”模板，单击使用模板进入画布编排界面，配置Jira Software触发事件和CodeArts Req节点事件的连接参数，最后保存业务流程编排并进行调试启动。
第二，Jira更新Issue同步到CodeArts Req，将Jira中有更新的Issue自动同步至CodeArts Req，减少手动同步数据的工作量。配置方式与新增同步类似，使用“Jira更新Issue同步到CodeArtsReq”模板完成编排配置即可。第三，定时同步CodeArts Req工作项状态到Jira，通过自动化定时同步减少因手动操作导致的错误和遗漏，确保两个系统中的数据保持一致性。这个场景使用“定时同步codeArtsReq工作项状态到JIRA”模板，配置CodeArts Req节点和修改Jira工作项状态节点的连接参数即可完成同步流程。
通过这套方案，企业可以确保各区域子公司的业务系统实时获取最新的项目信息，提高数据资产的复用率，保障跨系统协作的数据一致性和时效性。
七、企业微信/钉钉/飞书等即时通讯工具接入
CodeArts Req提供了丰富的消息通知机制，支持将工作项变更动态通过站内消息、邮件、钉钉、企业微信、飞书等通信工具及时推送给相关人员。在IPD系统设备类项目和IPD独立软件类项目中，用户可以在项目设置的通知页面配置钉钉和飞书通知参数。
CodeArts Link联接服务内置了常用的三方通讯插件，如飞书机器人、企业微信、钉钉等，实现研发工具和办公通讯应用的无缝连接。用户可以配置工作项变更时的自动通知规则，例如当需求状态变更为“已完成”时自动通过企业微信发送消息给相关责任人，或者定时从未解决的缺陷单中筛选数据并通过邮箱推送给项目经理，实现研发数据的及时感知和风险预警。
消息通知支持多种事件类型，包括工作项创建、工作项变更、工作项删除、评论新增、成员添加等。用户可以在项目级设置中配置不同事件的通知渠道和接收人，支持站内信、邮件、Webhook、企业微信订阅、钉钉订阅、飞书订阅等多种通知方式。
八、权限管理与安全策略
CodeArts Req的权限体系分为云服务级和项目级两层。云服务级权限通过IAM统一身份认证服务管理，支持基于角色的权限管理（RBAC）和基于属性的权限管理（ABAC）。项目级权限在项目内按角色进行精细化设置，预置了项目创建者、项目经理、开发人员、测试经理、测试人员、参与者、浏览者、运维经理等默认角色，每个角色拥有不同的操作权限。
当系统策略不能满足授权需求时，用户可以基于需求管理服务的系统策略创建更细粒度的自定义策略。创建自定义策略时无需了解策略语法，按可视化视图导航栏选择云服务、操作、资源、条件等策略内容即可生成自定义权限策略。用户还可以在项目内自定义成员的角色和权限，管理加入项目的成员并进行角色的动态调整。
在安全方面，推荐使用IAM子账号进行日常操作，避免直接使用主账号AK/SK。AK/SK作为长期访问凭证应妥善保管，定期轮换，并在凭证泄露时及时撤销重新生成。API调用时使用Token认证方式，Token有效期通常为24小时，应在代码中实现自动续期机制。
九、最佳实践与场景化应用
在需求变更频繁的场景下，CodeArts Req通过需求基线管理能力保障产品研发的有序推进。系统提供了基线评审和变更管理能力，实现需求基线-受控变更-变更评审-变更管理的过程化管理，让基线变更如门禁一样，达到阈值才能启动下一步。基线后的需求不允许随意更改，变更需经过评审流程，审批留痕，确保决策依据可查、责任可追溯。
针对产品或系统建立CodeArts项目后，建议确立Epic-Feature-Story的需求结构，对不同模块以及版本的管理通过工作项属性进行管理。CodeArts Req支持代码提交与工作项的自动关联，代码提交后可以自动关闭工作项，实现从需求到代码到缺陷的全流程追溯。需求开发过程中产生的设计文档、代码、用例、缺陷等被有机串联，形成追溯关系网，提前预警拦截风险。
在统计报表方面，CodeArts Req提供丰富的自定义报表功能，支持10+预置优秀实践报表，用户可按需多重维度自定义。项目仪表盘可视化管理项目进度、质量、工时人力。CodeArts Board效能洞察服务可以新建报表并定时更新CodeArts Req的各项工作项数据，管理人员可以在统一的看板上实时掌握项目进展和风险。
自定义模块功能允许用户根据产品模块定义模块名和责任人，若工作项未指定处理人时，选择工作项归属某个模块后，处理人会自动配置为该模块责任人，有效降低了人工分配的工作量。
十、常见问题解答
问1：CodeArts Req是否支持独立购买？
需求管理不支持单独购买，需配合CodeArts其他服务使用，开通任意CodeArts套餐即可使用需求管理服务。用户进入需求管理控制台后页面会提示前往购买CodeArts套餐。
问2：Jira与CodeArts Req如何实现数据双向同步？
通过CodeArts Link联接服务提供的资产模板实现。系统内置了Jira新增Issue同步至CodeArts Req、Jira更新Issue同步到CodeArts Req、定时同步CodeArts Req工作项状态到Jira三种场景模板，用户在CodeArts Link控制台使用模板完成画布编排配置即可实现双向同步。
问3：CodeArts Req API调用时返回401 Unauthorized错误如何解决？
401错误通常表示认证失败，可能原因包括：IAM Token已过期需要重新获取；X-Auth-Token请求头未正确设置；Token所用账号与请求的Region或项目不匹配。建议检查Token获取流程并确保在请求头中使用X-Auth-Token字段传递有效Token。
问4：如何配置需求变更时的自动消息通知？
进入CodeArts Req项目，单击“设置 > 通用设置 > 通知”，在通知页面可以选择配置站内消息、邮件通知、企业微信订阅、钉钉订阅、飞书订阅等多种通知方式。用户可以针对工作项创建、变更、删除、评论等不同事件类型分别配置通知渠道和接收人。
问5：跨项目协同下发需求最多支持多少个下游项目？
单条需求协同下发最多可下发给10个下游项目。在协同下发弹窗中单击“新增下发”即可逐条添加下游项目，每个需求最多同时下发至10个不同的项目团队。
问6：创建自定义扩展插件需要具备哪些开发技能？
开发UI插件需要掌握HTML、JavaScript、CSS等前端技术，通过CodeArts提供的REST API Client实现插件与各服务的交互。对于流水线插件，开发者可以使用Shell、Node.js、Python、Java等主流语言编写业务脚本。插件平台还提供低代码化前端页面生成能力，可通过拖拽组件快速搭建可视化表单。
