华为云用户手册

（可选）配置任务计划 如果任务的“集成模式”选择了“定时”，则您还需要为定时任务配置任务计划，告知ROMA Connect何时执行任务。 在创建数据集成任务后，如需修改任务计划，请先停止任务。 如果要集成同步的数据量较大，且任务的执行时间间隔较短，会出现上一次任务调度还没有执行完，下一次任务调度时间点已到的情况。此时ROMA Connect会暂停执行新的调度，等待上一次调度执行完成。 在创建任务页面中配置任务计划。ROMA Connect提供了两种配置任务计划的方式： 简单界面配置 界面配置当前仅支持配置简单的周期循环计划，例如每隔几分钟、几小时或几天执行一次。 图1 简单界面配置 表2 简单界面配置 参数 配置说明 QuartZ Cron表达式 选择“不使用”。 单位 任务执行周期的单位，与“调度周期”配合使用，可设置为“分”、“时”、“日”、“周”或“月”。 调度周期 任务执行周期，根据“单位”选择的不同，可设置值的范围不同。 例如“单位”选择“日”，“调度周期”设置为“1”，则表示数据集成任务每天执行一次。 生效时间 任务的开始执行时间。 描述 填写任务计划的描述信息。 QuartZ Cron表达式配置 QuartZ Cron表达式支持配置灵活多样的任务计划，例如每天凌晨1点到凌晨4点之间，每隔15分钟执行一次任务。这种计划，简单界面配置无法实现，必须通过QuartZ Cron表达式实现。 0 0/15 1-4 * * ? 图2 QuartZ Cron表达式配置 表3 QuartZ Cron表达式配置 参数 配置说明 QuartZ Cron表达式 选择“使用”。 表达式 任务计划对应的QuartZ Cron表达式，ROMA Connect当前仅支持分钟级的计划，故表达式中的“秒”固定为“0”。关于QuartZ Cron表达式的使用详解，请参考附录：QuartZ Cron表达式配置说明。 例如每天凌晨1点到凌晨4点之间，每隔15分钟执行一次任务，该计划对应的QuartZ Cron表达式为： 0 0/15 1-4 * * ? 生效时间 任务的开始执行时间。 描述 填写任务计划的描述信息。 完成任务计划配置后，继续进行下一部分配置，配置源端数据信息。

配置集成应用授权 登录ROMA Connect控制台，在“实例”页面单击具体实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“集成应用”，在页面中找到要授权的集成应用，单击该集成应用后的“应用授权管理”进行授权配置。 管理员权限（Tenant Administrator权限）的用户可以对所有用户创建的集成应用进行授权配置，非管理员权限的用户只能对自己创建的集成应用进行授权配置。 在“应用授权管理”弹窗中为 IAM 用户授权。 在“用户列表”处勾选要授权的IAM用户。 在“已选择”处为已选择的IAM用户配置集成应用的管理权限。 可为每个用户单独配置权限，也可以单击“权限”右侧的“”为所有已选择用户批量配置权限。 图1 配置应用授权参数 表1 应用权限说明 权限 FDI APIC MQS LINK read 可查看授权应用的数据源。 可查看、调试和导出授权应用的API。 可查看和导出授权应用的Topic。 可查看授权应用的设备、产品和规则，可导出授权应用的设备、产品和规则，并调试设备。 modify 可在授权应用下创建和编辑数据源。 可在授权应用下创建、编辑、发布、下线和导入API。 可在授权应用下创建和编辑Topic。 可在授权应用下创建和编辑设备、产品和规则，可导入设备、产品和规则，可重置设备和产品的密码。 delete 可删除授权应用的数据源。 可删除授权应用的API。 可删除授权应用的Topic。 可删除授权应用的设备、产品和规则，可删除产品属性、Topic类、规则数据源端、规则数据目的端。 access 不涉及。 可对授权应用的API进行授权、访问控制、流量控制、签名密钥绑定API配置。 可对授权应用的Topic进行应用权限配置。 可对设备进行命令下发和强制下线，并且可以对协议为OPC UA和Modbus的设备进行插件配置。 admin 应用管理员权限。 单击“确认”，完成集成应用的授权配置。 您可以在集成应用列表中，单击集成应用左侧的“”，查看该集成应用已授予权限的IAM用户以及授予的权限范围。 使用3中被授权的IAM用户登录ROMA Connect控制台并进入对应的ROMA Connect实例，查看该用户是否具备该集成应用资源的相关管理权限。

概述 ROMA Connect对用户资源实现了严格的权限管理，在同一实例内，非管理员权限（Tenant Administrator权限）的IAM用户只能查看和管理自己创建的集成应用和资源，默认不能查看其他IAM用户创建的集成应用和资源。ROMA Connect支持通过集成应用授权的方式，把集成应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 集成应用的授权管理功能，仅能解决同一账号下其他用户间共享的权限，对应用对象进行操作的权限仍然由IAM统一控制。

前提条件 ROMA Connect与负载通道中服务器之间的网络互通。 若ROMA Connect实例与服务器在相同VPC内时，可直接访问服务器。 若ROMA Connect实例与服务器在同一区域的不同VPC内时，可通过创建VPC对等连接，将两个VPC的网络打通，实现同一区域跨VPC访问服务器。具体步骤请参考VPC对等连接说明。 若ROMA Connect实例与后端服务在不同区域的不同VPC内时，可通过创建云连接实例并加载需要互通的VPC，将两个VPC的网络打通，实现跨区域跨VPC访问服务器。具体步骤请参考跨区域VPC互通。 若ROMA Connect实例与服务器通过公网互通，请确保ROMA Connect实例已绑定弹性IP。 用户账号需要具备VPC Administrator角色权限。

前提条件 在调用API前，确保您的业务系统所在网络与API的访问 域名 或地址互通。 若业务系统与ROMA Connect实例在相同VPC内时，可直接访问API。 若业务系统与ROMA Connect实例在同一区域的不同VPC内时，可通过创建VPC对等连接，将两个VPC的网络打通，实现同一区域跨VPC访问API。具体步骤请参考VPC对等连接说明。 若业务系统与ROMA Connect实例在不同区域的不同VPC内时，可通过创建云连接实例并加载需要互通的VPC，将两个VPC的网络打通，实现跨区域跨VPC访问API。具体步骤请参考跨区域VPC互通。 若业务系统与ROMA Connect实例通过公网互通，请确保ROMA Connect实例已绑定弹性IP。

调用API 构造API请求，示例如下： POST https://{Address}/{Path}?{Query} {Header} { {Body} } POST：请求方法，需替换为获取API的请求信息中获取的请求方法。 {Address}：请求地址，需替换为获取API的请求信息中获取的域名地址。您也可以使用IP地址访问API， API调用场景 API请求参数配置 使用域名调用API ROMA Connect允许使用分组分配的子域名或分组绑定的域名调用API，无需另外配置。 使用IP调用DEFAULT分组的API ROMA Connect允许使用IP地址调用DEFAULT分组下的API，无需另外配置。 使用IP调用非DEFAULT分组的API ROMA Connect的实例配置参数“app_route”已设置为“on”，允许通过IP访问API。 ROMA Connect不允许使用IP地址直接调用非DEFAULT分组下的API，需要在请求消息中添加Header参数“X-HW-ID”，参数值为API所授权凭据的Key。 {Path}：请求路径，需替换为获取API的请求信息中获取的URL。 {Query}：查询参数，可选，格式为“参数名=参数取值”，例如limit=10，多个查询参数之间使用“&”隔开。需根据获取API的请求信息中获取的请求参数进行设置。 {Header}：请求头参数，格式为“参数名: 参数取值”，例如Content-Type: application/json。需根据获取API的请求信息中获取的请求参数进行设置。 {Body}：请求消息体，JSON格式。需根据获取API的请求信息中获取的请求体内容描述进行设置。 为API请求添加认证信息。 Site实例中不支持华为IAM认证。 API认证方式 API请求参数配置 APP认证（签名认证） 使用获取的SDK对API请求进行签名，具体请参考APP认证开发。 APP认证（简易认证） 在API请求中添加Header参数“X-Apig-AppCode”，参数值为获取API的认证信息中获取到的AppCode。 APP认证（绿色通道白名单） 在API请求中添加Header参数“X-HW-ID”，参数值为获取API的认证信息中获取到的Key。 APP认证（app_secret认证） ROMA Connect的实例配置参数“app_secret”已设置为“on”，开启app_secret认证。 在API请求中添加Header参数“X-HW-ID”，参数值为获取API的认证信息中获取到的Key。 在API请求中添加Header参数“X-HW-AppKey”，参数值为获取API的认证信息中获取到的Secret。 APP认证（app_basic认证） ROMA Connect的实例配置参数“app_basic”已设置为“on”，开启app_basic认证。 在API请求中添加Header参数“Authorization”，参数值为"Basic "+base64(appkey+":"+appsecret)，其中appkey和appsecret分别为获取API的认证信息中获取到的Key和Secret。 APP认证（双重认证） 在API请求中同时携带APP认证和自定义认证的认证信息。 IAM认证（Token认证） 先获取云服务平台的认证Token，然后在API请求中添加Header参数“X-Auth-Token”，参数值为认证Token，具体请参考IAM认证开发（Token）。 IAM认证（AK/SK认证） 使用获取的SDK对API请求进行签名，具体请参考IAM认证开发（AK/SK）。 IAM认证（双重认证） 在API请求中同时携带IAM认证和自定义认证的认证信息。 自定义认证 根据自定义认证的定义，在API请求参数中携带相关认证信息进行认证。 无认证 无需认证，可直接调用API。

转换证书为PEM格式 格式类型 转换方式（通过OpenSSL工具进行转换） CER/CRT 将“cert.crt”证书文件直接重命名为“cert.pem”。 PFX 提取私钥命令，以“cert.pfx”转换为“key.pem”为例。 openssl pkcs12 -in cert.pfx -nocerts -out key.pem 提取证书命令，以“cert.pfx”转换为“cert.pem”为例。 openssl pkcs12 -in cert.pfx -nokeys -out cert.pem P7B 证书转换，以“cert.p7b”转换为“cert.cer”为例。 openssl pkcs7 -print_certs -in cert.p7b -out cert.cer 将“cert.cer”证书文件直接重命名为“cert.pem”。 DER 提取私钥命令，以“privatekey.der”转换为“privatekey.pem”为例。 openssl rsa -inform DER -outform PEM -in privatekey.der -out privatekey.pem 提取证书命令，以“cert.cer”转换为“cert.pem”为例。 openssl x509 -inform der -in cert.cer -out cert.pem

概述 如果您需要对您所拥有的ROMA Connect进行精细的权限管理，您可以使用 统一身份认证 服务（Identity and Access Management，简称IAM），通过IAM，您可以： 根据企业的业务组织，在您的华为云账号中，给企业中不同职能部门的员工创建IAM用户，让员工拥有唯一安全凭证，并使用ROMA Connect资源。 根据企业用户的职能，设置不同的访问权限，以达到用户之间的权限隔离。 将ROMA Connect资源委托给更专业、高效的其他华为云账号或者云服务，这些账号或者云服务可以根据权限进行代运维。 如果华为云账号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用ROMA Connect服务的其它功能。

新增用户组并授权 创建用户组并授权 在IAM控制台创建用户组，并授予ROMA Connect服务只读权限“ROMA ReadOnlyAccess”。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入1中创建的用户组。 用户登录并验证权限 使用新创建的用户登录控制台，切换至授权区域，验证权限： 在“服务列表”中选择应用与 数据集成平台 ，进入ROMA Connect主界面，单击右上角“购买ROMA Connect实例”，尝试购买ROMA Connect实例，如果无法购买ROMA Connect实例（假设当前权限仅包含ROMA ReadOnlyAccess），表示“ROMA ReadOnlyAccess”已生效。 在“服务列表”中选择除ROMA Connect外（假设当前权限仅包含ROMA ReadOnlyAccess）的任一服务，若提示权限不足，表示“ROMA ReadOnlyAccess”已生效。

为已有用户组授权 给用户组授权 选择已有用户组，并授予ROMA Connect服务只读权限“ROMA ReadOnlyAccess”。 用户登录并验证权限 使用1中用户组下的用户登录控制台，切换至授权区域，验证权限： 在“服务列表”中选择应用与数据集成平台，进入ROMA Connect主界面，单击右上角“购买ROMA Connect实例”，尝试购买ROMA Connect实例，如果无法购买ROMA Connect实例，表示“ROMA ReadOnlyAccess”已生效。

创建CodeArts Build连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Build”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

配置参数 表1 查询指定代码仓库最近一次成功的构建历史 参数 说明 project_id 项目ID。 region_id 区域ID。 repository_name 代码仓库名，不支持中文。 表2 获取构建历史详情信息接口 参数 说明 job_id 构建的任务ID。编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 build_number 构建任务的构建编号，从1开始，每次构建递增1。 region_id 区域ID。 表3 执行构建任务 参数 说明 region_id 区域ID。 body 输入请求体内容。 表4 根据开始时间和结束时间查看构建任务的构建成功率 参数 说明 job_id 构建的任务ID。编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 region_id 区域ID。 start_time 区间开始时间，格式yyyy-MM-dd。 end_time 区间结束时间，格式yyyy-MM-dd。 表5 查看任务运行状态 参数 说明 job_id 构建的任务ID。编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 region_id 区域ID。 表6 查看项目下用户的构建任务列表 参数 说明 project_id 项目ID。 region_id 区域ID。 page_index 分页页码， 表示从此页开始查询， page_index大于等于0。 page_size 每页显示的条目数量，page_size小于等于100。 表7 KeyStore文件下载 参数 说明 region_id 区域ID。 file_name 下载的文件名称。 domain_id 租户ID。32位数字、小写字母组合。 表8 根据开始时间和结束时间查看构建任务的构建历史列表 参数 说明 job_id 构建的任务ID。编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 region_id 区域ID。 offset 分页页码， 表示从此页开始查询， offset大于等于0。 limit 每页显示的条目数量，limit小于等于100。 start_time 区间开始时间，格式yyyy-MM-dd。开始时间和结束时间间隔不能超过30天。 end_time 区间结束时间，格式yyyy-MM-dd。开始时间和结束时间间隔不能超过30天。 表9 查看构建任务的构建历史列表 参数 说明 job_id 构建的任务ID。编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 region_id 区域ID。 offset 分页页码， 表示从此页开始查询， offset大于等于0。 limit 每页显示的条目数量，limit小于等于100。 interval 距今天的时间区间（单位：天），interval小于等于30。

创建短信服务连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“短信服务”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 App Key 接入密钥。创建消息&短信应用时，平台会自动生成APP_Key和APP_Secret，用于调用短信API时的鉴权。 App Secret 接入密钥。创建消息&短信应用时，平台会自动生成APP_Key和APP_Secret，用于调用短信API时的鉴权。 描述 填写连接器的描述信息，用于识别不同的连接器。

创建CodeArts Req连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Req”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

支持的动作 查询迭代下工作项状态的统计数据（处理人维度） 查询项目的状态列表 更新项目的领域 查询项目的领域列表 删除项目的模块 取消领域与项目的关联关系 查询项目的模块列表 创建项目的领域 查看迭代历史记录 查询关联用例 查询当前工作项已经关联的代码提交记录 / 分支创建记录 查询当前工作项已经关联的关联Wiki 查询当前工作项已经关联的工作项 查询Scrum项目的工作项流转配置 获取项目概览 获取需求统计信息 查询项目下所有工作项的历史记录 获取bug统计信息 更新工作项 按用户查询工时（多项目） 批量删除工作项 删除工作项 获取工作项历史记录 创建工作项 查询项目的工作项 高级查询工作项 查询工作项详情 获取子工作项 按用户查询工时（单项目） 获取当前用户信息 查看迭代详情 获取指定项目的迭代列表 创建项目 更新Scrum项目迭代 删除项目迭代 批量删除项目的迭代 创建Scrum项目迭代 检查项目名称是否存在 获取指定工作项的评论列表 获取工作项完成率 获取指定项目的成员用户列表 添加项目成员 查询项目列表 查询缺陷密度 查询Scrum工作项自定义字段 细粒度权限用户创建工作项 查询人均bug 创建项目的模块 更新项目的模块 更新成员在项目中的角色 批量添加项目成员 批量删除项目成员 查询需求按时完成率 获取项目详情 更新项目 删除项目

配置参数 表1 实时计算单个自定义报表 参数 说明 project_id 项目ID。 plan_id 分支/计划ID。 region_id 区域ID。 name 报表名称。 workpiece_type 工件类型（用例：case，测试套：suite）。 analysis_dim_row 分析维度。 compare_dim_column 对比维度。 creatorIds 创建人。 ownerIds 所属人。 ranks 级别。 releaseIds releaseId。 status 状态。 moduleIds 级别。 results 结果。 labelIds 标签。 startTime 开始时间。 endTime 结束时间。 isAssociateIssue 是否关联需求。 表2 查询某个测试计划下的需求树 参数 说明 project_id 项目ID。 plan_id 测试计划ID。 region_id 区域ID。 offset 起始偏移量。 limit 每页显示条目数量，最大支持200条。 表3 查询某测试计划下的操作历史 参数 说明 project_id 项目ID。 plan_id 测试计划ID。 region_id 区域ID。 offset 起始偏移量。 limit 每页显示的条目数量，最大支持200条。 表4 获取环境参数分组列表 参数 说明 project_id 项目ID。 region_id 区域ID。 offset 起始偏移量。 limit 每页显示的条目数量，最大支持200条。 表5 通过导入仓库中的文件生成接口测试套 参数 说明 project_id 项目ID。 region_id 区域ID。 testsuite_name 要生成的测试套名称。 repository_id 仓库ID。 repository_branch 仓库分支。 file_path 仓库中yaml或json文件的相对路径，仅支持swagger 2.0版本的yaml和json文件。 表6 计划中批量添加测试用例 参数 说明 project_id 项目ID。 plan_id 计划ID。 region_id 区域ID。 service_id 注册测试类型服务接口返回的服务ID。 testcase_id_list 计划下包含的用例个数，数组长度小于50个，只能包含一种测试类型。 表7 项目下查询测试计划列表v2 参数 说明 project_id 项目ID。 region_id 区域ID。 offset 起始偏移量。 limit 每页显示的条目数量，最大支持200条。 name 针对测试计划名称模糊查询。 current_stage 测试计划所处截断（create,design,execute,report）。 表8 项目下创建计划 参数 说明 project_id 项目ID。 region_id 区域ID。 name 计划名称。 assigned_id 处理者ID。 service_id_list 计划下包含的用例类型，数组长度小于10。 start_date 计划开始时间，要求用UTC时间表示，如2020-03-04。 end_date 计划结束时间，要求用UTC时间表示，如2020-03-04。 表9 项目下查询测试计划列表 参数 说明 project_id 项目ID。 region_id 区域ID。 name 针对测试计划名称模糊查询使用。 current_stage 测试计划所处截断（create,design,execute,report）。 offset 页号，取值范围1-20000。 limit 每页显示条目数量，取值范围1-200。 表10 通过用例编号获取测试用例详情 参数 说明 project_id 项目ID。 region_id 区域ID。 testcase_number 用例编号。 表11 批量更新测试用例结果 参数 说明 project_id 项目ID。 region_id 区域ID。 service_id 注册测试类型服务接口返回的服务ID。 testcase_id 测试用例ID。 execute_id 注册服务执行ID。 result_id 测试用例结果，（0-成功，1-失败，5-执行中，6-停止）。 end_time 用例结束执行的时间戳，在执行结束时该字段必填。 duration 执行用例持续时长ms，更新状态时该字段必传。 description 用于记录该次结果执行的备注信息。 表12 批量执行测试用例 参数 说明 project_id 项目ID。 region_id 区域ID。 service_id 注册测试类型服务接口返回的服务ID。 plan_id 测试计划ID testcase_id 测试用例ID execute_id 注册服务执行ID。 result_id 测试用例结果（0-成功，1-失败，5-执行中，6-停止）。 start_time 用例开始执行的时间戳，在执行开始时该字段必填。 表13 更新自定义测试服务类型用例 参数 说明 project_id 项目ID。 testcase_id 测试用例ID。 region_id 区域ID。 name 页面上显示的用例名称。 service_id 注册测试类型服务接口返回的服务ID。 rank_id 测试用例等级，可选值为[0，1，2，3，4]，不填默认为2。 testcase_number 用例编号，不填时自动生成。 description 测试用例描述信息。 preparation 执行该测试用例时需要满足的前置条件。 expect_result 测试用例预期结果信息。 test_step 测试步骤描述信息。 label_list 标签名称列表。 module_id 模块号。 test_version_id 测试版本号。 fix_version_id 迭代号。 assigned_id 处理者ID信息。 issue_id 用例关联的需求ID信息。 status_id 测试用例状态信息（0-新建，5-设计中，6-测试中，7-完成）。 defect_id_list 缺陷ID信息。 表14 获取测试用例详情 参数 说明 project_id 项目ID。 testcase_id 测试用例ID。 region_id 区域ID。 表15 批量删除自定义测试服务类型用例 参数 说明 project_id 项目ID。 region_id 区域ID。 service_id 注册测试类型服务接口返回的服务ID。 test_case_id_list 测试用例ID。 表16 创建自定义测试服务类型用例 参数 说明 project_id 项目ID。 region_id 区域ID。 name 页面上显示的用例名称。 service_id 该值由注册接口返回。 rank_id 测试用例等级，可选值为[0，1，2，3，4]，不填默认为2。 testcase_number 用例编号，不填时自动生成。 description 测试用例描述信息。 preparation 执行该测试用例时需要满足的前置条件。 expect_result 测试用例预期结果信息。 test_step 测试步骤描述信息。 label_list 标签名称列表。 module_id 模块号。 test_version_id 测试版本号。 fix_version_id 迭代号。 assigned_id 处理者ID信息。 issue_id 用例关联的需求ID信息。 表17 删除已注册服务 参数 说明 service_id 注册服务ID，该值由注册接口返回。 region_id 区域ID。 表18 更新已注册服务 参数 说明 service_id 注册服务ID，该值由注册接口返回。 region_id 区域ID。 service_name 测试类型名称，用于界面显示，不能使用当前保留名。 server_host 域名，服务会通过此域名进行接口调用，以https/http开头，长度小于等于128位字符。TestHub将会通过此域名下的接口，保证服务数据与客户系统数据的一致性。 表19 新测试类型服务注册 参数 说明 region_id 区域ID。 service_name 测试类型名称，用于界面显示，不能使用当前保留名。 server_host 域名，服务会通过此域名进行接口调用，以https/http开头，长度小于等于128位字符。TestHub将会通过此域名下的接口，保证服务数据与客户系统数据的一致性。 表20 用户获取自己当前已经注册的服务 参数 说明 region_id 区域ID。

创建CodeArts TestPlan连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts TestPlan”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

支持的动作 实时计算单个自定义报表 查询某个测试计划下的需求树 查询某测试计划下的操作历史 获取环境参数分组列表 通过导入仓库中的文件生成接口测试套 计划中批量添加测试用例 项目下查询测试计划列表v2 项目下创建计划 项目下查询测试计划列表 通过用例编号获取测试用例详情 批量更新测试用例结果 批量执行测试用例 更新自定义测试服务类型用例 获取测试用例详情 批量删除自定义测试服务类型用例 创建自定义测试服务类型用例 删除已注册服务 更新已注册服务 新测试类型服务注册 用户获取自己当前已经注册的服务

配置参数 以下配置等价于使用命令ZADD key score member，可以向有序集合中添加元素，其中key是有序集合的名称，score是元素的分数，member是元素的成员值，含义为向有序集合myset中添加元素“apple”，其分数为3。 参数 说明 有序集合 zadd zrem zcard zrangebyscore/zrevrangebyscore zrange/zrevrange 键：有序集合的名称。 值：元素的成员值。 分数：元素的分数。 起始索引：分数最小值。 终止索引：分数最大值。 集合 srem sismember srandmember spop sadd 键：集合的名称。 值：元素的成员值。 哈希 hdel hlen hset/hsetnx hincrby hget hgetall 键：哈希的名称。 字段名：哈希中key的值。 值：哈希中key对应的value值。 键存在时不做操作：否对应zset操作，是对应zsetnx操作。 增量值：将哈希中的某个数值型字段增加一个指定的值。 列表 lrange lpop/rpop lpush/rpush lrem llen lindex leset 表名：数据库中数据表的名字。 插入数据：插入操作中目标记录各个字段的值。 字符串 set/setnx append setbit get incrby decrby getrange strlen 键：字符串的名称。 值：字符串的值。 过期时间（秒）：字符串的过期时间。 键存在时不做操作：否使用set命令， 是使用setnx命令。 键 del lrem expire expireat ttl persist 键：key的名称。

创建Redis连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“Redis”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 主机IP地址 填写数据库的连接IP地址。 端口 填写数据库的连接端口号。 数据库 填写要连接的数据库名。 密码 连接数据库的密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

创建CodeArts Repo连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“华为云服务”类别下的“CodeArts Repo”。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

支持的操作 获取分支目录下的文件；获取仓库统计数据；修改被流水线引用的仓库状态；判断用户是否有仓库的管理员权限；设置仓库是公开状态还是私有状态；获取一个项目下可以设置为公开状态的仓库列表；获取公开示例模板列表；获取项目下所有仓库信息；校验指定项目下的仓库名；创建仓库；根据仓库名组名获取仓库短id，用以拼接与commitid对应提交详情页面url；根据组名和仓库名查询某仓库某分支对应的提交；查询指定仓库的webhook；为指定仓库添加hook；删除指定仓库的 hook；查询某仓库对应的分支；根据仓库id查询仓库某分支对应的提交，提供更多可选参数；添加部署密钥；删除仓库部署密钥；获取仓库上一次的提交统计信息；仓库统计；查询项目下的某个仓库；删除仓库；获取仓库所有成员记录；添加仓库成员；设置成员在仓库中的角色；删除仓库成员；查看仓库的创建状态；https账号密码校验；获取ssh key列表；添加ssh key；检验私钥是否有拉取代码的权限；删除用户公钥；查询用户的所有仓库；创建项目、仓库；创建项目并fork仓库；查询项目下的所有仓库；查询某仓库的标签列表；新建标签；查询某个仓库的详细信息；查询某个仓库的提交信息；创建提交；查询某个仓库的特定提交信息；查询某个仓库的提交差异信息；查询某个仓库的文件信息；获取代码提交行数；下载仓库；新建保护分支；获取仓库分支列表；分支关联工作项；获取仓库合并请求列表；获取仓库合并请求详情。

创建JIRA连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“Jira Software”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 连接类型 选择JIRA的连接类型。 Cloud：指在云端部署的JIRA实例，用户可以使用任何Web浏览器从任何地方访问它。 On-Premise：指本地安装的JIRA实例，需要在自己的服务器或本地PC上安装和配置JIRA。 连接地址 填写JIRA的连接地址。 当“连接类型”选择“Cloud”时，连接地址格式为https://your-domain.atlassian.net。 your-domain指组织或团队的域名，需要有有效的Jira Cloud订阅才能访问该地址。如果不确定您的Jira Cloud连接地址，可以从Atlassian账户或管理员处获取。 当“连接类型”选择“On-Premise”时，填写JIRA所在服务器的IP地址或主机名，例如：http://192.168.0.1:8080或http://jira.example.com:8080。 认证类型 选择JIRA的认证类型，支持选择“Basic”和“API Token”。 用户名 仅当“认证类型”选择“Basic”时需要配置。 连接JIRA的用户名。 密码 仅当“认证类型”选择“Basic”时需要配置。 连接JIRA的用户密码。 邮箱 仅当“认证类型”选择“API Token”时需要配置。 JIRA的邮箱。 API Token 仅当“认证类型”选择“API Token”时需要配置。 用户需要在JIRA的个人设置中生成一个API Token，API Token是一种用于身份验证的令牌，它允许JIRA用户通过API访问其账户和相关数据。 描述 填写连接器的描述信息，用于识别不同的连接器。

支持的操作 通用 表格识别 通用文字识别 网络图片识别 智能分类识别 手写 文字识别 身份证识别 行驶证识别 驾驶证识别 护照识别 银行卡识别 营业执照识别 道路运输证识别 车牌识别 名片识别 VIN码识别 增值税发票识别 发票验真 机动车销售发票识别 出租车发票识别 火车票识别 定额发票识别 车辆通行费发票识别 飞机行程单识别 电子面单识别 保险单识别 财务报表识别 道路运输从业资格证识别 自定义模板OCR

创建文字识别连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“华为云服务”类别下的“文字识别”。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。 描述 填写连接器的描述信息，用于识别不同的连接器。

支持的动作 修改任务规则集 任务配置高级选项 查询任务检查失败日志 任务配置屏蔽目录 查询任务的高级选项 新建检查任务 查询任务规则集的检查参数 任务配置检查参数 设置每个项目对应语言的默认规则集配置 创建自定义规则集 查询规则集列表 查看规则集的规则列表 查询任务的已选规则集列表 删除自定义规则集 查询任务的已选规则集列表 获取规则列表接口 查询任务规则集的检查参数 终止检查任务 查询缺陷详情的统计 修改缺陷状态 查询任务执行状态 历史扫描结果查询 查询缺陷概要 查询cmertrics缺陷概要 查询缺陷详情 查询任务列表 执行检查任务 删除检查任务

创建CodeArts Check连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Check”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

配置参数 表1 获取项目下流水线执行状况 参数 说明 region_id 区域ID。 project_id 项目ID。 start_date 起始日期，起始日期和结束日期间隔不超过一个月，查询包含起始日期。 end_date 结束日期，起始日期和结束日期间隔不超过一个月，查询包含结束日期。 offset 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit 每次查询的条目数量。 表2 获取流水线状态 参数 说明 pipeline_id 要获取状态的流水线ID。 region_id 区域ID。 build_id 要获取状态的执行ID。 表3 获取流水线列表接口 参数 说明 region_id 区域ID。 pipeline_name 流水线名字。参数存在，则进行模糊匹配。 project_ids devCloud项目ids。该参数存在，则获取对应项目下的流水线列表，逗号分隔，id个数取值[0,10]；如果不存在，则获取调用方所属租户的流水线列表。 creator_ids 创建人id。该参数存在，逗号分隔，id个数取值[0,10]。 executor_ids 执行人id。该参数存在，逗号分隔，id个数取值[0,10]。 status 流水线运行状态。取值范围：waiting,running,verifying,handling,suspending,completed。 outcome 流水线结果，标记流水线。error、success、aborted。 sort_key 用于排序的字段。取值为：pipeline_name,create_time,start_time。 sort_dir 排序类型。asc按排序字段升序，desc按排序字段降序。 git_url codehub搜索链接：git@codehub.XXX.git；gitee搜索链接：git@gitee.com.XXX.git；github搜索链接：git@github.com.XXX.git等。 offset 偏移量。表示从此偏移量开始查询，offset大于等于0，默认取值为0。 limit 每次查询的条目数量。取值[10-50]，默认取值为10。 表4 删除流水线 参数 说明 pipeline_id 要删除的流水线ID。 region_id 区域ID。 表5 批量获取流水线状态 参数 说明 region_id 区域ID。 pipeline_ids 要获取状态的流水线ID，用逗号隔开。 表6 停止流水线 参数 说明 pipeline_id 流水线ID。 region_id 区域ID。 build_id 流水线执行ID。 表7 启动流水线 参数 说明 pipeline_id 流水线ID。 region_id 区域ID。 name 构建参数名。 value 构建参数值，最大长度为8192。 表8 检查流水线创建状态 参数 说明 task_id 实例ID。 region_id 区域ID。 表9 查询模板详情 参数 说明 template_id 模板ID。 region_id 区域ID。 template_type 模板类型。 source 接口调用方。 表10 查询模板列表 参数 说明 region_id 区域ID。 template_type 模板类型。 is_build_in 是否内置模板。 offset 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit 每页显示的条目数量。 name 模板名称，匹配规则为模糊匹配。 sort 排序字段。 asc 是否正序。

创建CodeArts Pipeline连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Pipeline”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

创建CodeArts Artifact连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Artifact”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。