华为云用户手册

创建Sql Server连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“Sql Server”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 区域 选择区域。 项目 选择项目。 实例 选择实例，用于后续验证连通性。 连接与安全 选择数据库的连接模式。当前支持“默认”模式，由系统根据用户配置自动拼接数据源连接字符串。 默认：由系统根据用户配置自动拼接数据源连接字符串。 专业：由用户自己输入数据源连接字符串。 主机IP地址 仅当“连接与安全”选择“默认”时需要配置。 填写数据库的连接IP地址。 端口 仅当“连接与安全”选择“默认”时需要配置。 填写数据库的连接端口号。 数据库名 仅当“连接与安全”选择“默认”时需要配置。 填写要连接的数据库名。 连接字符串 仅当“连接与安全”选择“专业”时需要配置。 填写Sql Server数据库的JDBC格式连接串，例如：jdbc:sqlserver://{hostname}:{port};DatabaseName={dbname}。 用户名 连接数据库的用户名。 密码 连接数据库的用户密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

配置参数 表1 获取记录 参数 说明 表名 选择或者填写要查询的数据库中的表名。 字段名 选择要查询数据表的字段名。 WHERE条件 配置要查询数据的条件值（注意值要用英文单引号包住）。 Order by字段 填写返回结果的排序字段。 Limit条数 填写返回结果的每页数据条数。 Offset偏移量 填写分页查询的偏移量。 表2 增量获取记录 参数 说明 表名 选择或者填写要增量获取记录的数据库中的表名。 字段名 选择要查询数据表的字段名。 WHERE条件 配置要查询数据的条件值（注意值要用英文单引号包住）。 Order by字段 填写返回结果的排序字段。 增量获取时区 增量数据获取开始时区。 增量获取时间戳字段 增量数据获取的时间戳字段。 增量获取时间戳初始值 增量数据获取的时间戳初始值。 重置增量获取时间初始值 选择是否开启重置增量获取时间初始值。 增量获取时间补偿(毫秒） 增量获取补偿增量迁移初始时间戳。 表3 添加记录 参数 说明 表名 选择或者填写数据库中要插入数据的表名。 插入数据 填写插入操作中目标字段的值（注意值要用英文单引号包住）。 表4 更新记录 参数 说明 表名 选择或者填写数据库中要更新数据的表名。 更新数据 填写更新操作中目标字段的值（注意值要用英文单引号包住）。 WHERE条件 配置要更新数据的条件值（注意值要用英文单引号包住）。 表5 同步数据 参数 说明 表名 选择或者填写数据库中要同步数据的表名。 清空表 每次同步数据，是否先清空表。 表6 删除记录 参数 说明 表名 选择或者填写数据库中要删除数据的表名。 WHERE条件 配置要删除数据的条件值（注意值要用英文单引号包住）。 表7 自定义SQL 参数 说明 执行语句 填写操作数据库的原生SQL语句。 执行语句内容会明文展示所输入信息，请防止信息泄露。 请谨慎使用drop、truncate等非查询类语句。

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

目的端-数据格式为 CS V样例 是否跳过标题：CSV文件的表头，数值 true/false：输出数据是/否含有表头。 分隔符：文件中每列数据通过单元格进行分隔，单元格可以为“制表符”、“空格”、“逗号”、“分号”。 场景1：目的端数据源选择数据格式“CSV”，是否跳过标题：true，字段分隔符：逗号 。 导入文件时，当是否跳过标题选择“true”，默认解析csv第一行为字段名。 源端MySQL数据库表 demo.statistics 中的数据： id city uuid1 suzhou uuid2 shanghai 数据映射输出数据为： ManufacturerId, ProductName uuid1, suzhou uuid2, shanghai 场景2：目的端数据源选择数据格式“CSV”，是否跳过标题：false，字段分隔符：逗号。 导入文件时，当是否跳过标题选择“false”，不使用导入文件的头字段，系统默认设置字段filedN。 源端MySQL数据库表 demo.statistics 中的数据： id city uuid1 suzhou uuid2 shanghai 数据映射输出数据为： uuid1, suzhou uuid2, shanghai

源端-数据格式为JSON样例 当源端数据源的类型为“JSON”时，在使用数据映射时选择数据格式“JSON”，将源端数据源的输出作为源端数据源页签中“导入文件”的输入，根据文件的编码格式格式选择导入文件编码，可选项有GB2312、UTF-8和ASCII。此时源端数据源页签中会根据导入的文件内容自动生成相应的字段。 目的端数据格式选择“MySQL”，在选择表名后，目的端数据源页签会自动生成数据库表中的字段。 以下面的组合应用为例，该组合应用的主要功能是调用Open API获取OBS指定桶的对象列表，并将结果中的桶名称和对象名称通过数据映射，映射到MySql指定表中的相关字段，然后使用MySql添加记录的操作将桶名和对象名存储到MySql中。其中， 对象存储服务 OBS产生的结果是数据映射的源端数据源，MySql是目的端数据源。可以通过使用Open API调用OBS连接器执行获取桶内对象列表的操作结果获得远端数据源的导入文件。也可以根据OBS连接器执行获取桶内对象列表的操作结果手动添加字段信息。 源端导入的文件内容： { "responseHeaders": { "bucket-location": "cn-north-7", "connection": "keep-alive", "content-length": "504", "content-type": "application/xml", "date": "2024-04-24T07:07:43.000+00:00", "id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAA BCS bOSbK ncLEgZnxffa8vFPuDgVIt7n9", "request-id": "0000018F0EEE84734012ACF15A46395E", "server": "OBS" }, "originalHeaders": { "connection": "keep-alive", "content-length": "504", "content-type": "application/xml", "date": "Wed, 24 Apr 2024 07:07:43 GMT", "server": "OBS", "x-obs-bucket-location": "cn-north-7", "x-obs-id-2": "32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSbOSbK+ncLEgZnxffa8vFPuDgVIt7n9", "x-obs-request-id": "0000018F0EEE84734012ACF15A46395E" }, "statusCode": 200, "objectSummaries": [ { "bucketName": "test0223", "objectKey": "test0424.txt", "owner": { "displayName": null, "id": "0ab78f256080d2890feac0086234d7c0" }, "metadata": { "responseHeaders": {}, "originalHeaders": {}, "statusCode": 0, "lastModified": "2024-04-24T06:51:46.566+00:00", "contentLength": 19, "contentType": null, "contentEncoding": null, "contentDisposition": null, "cacheControl": null, "contentLanguage": null, "expires": null, "etag": "\"0b26e313ed4a7ca6904b0e9369e5b957\"", "contentMd5": null, "crc64": null, "storageClass": "STANDARD", "webSiteRedirectLocation": null, "nextPosition": -1, "appendable": false, "objectStorageClass": "STANDARD", "allMetadata": {}, "metadata": {}, "requestId": "" }, "objectContent": null } ], "commonPrefixes": [], "extendCommonPrefixes": [], "bucketName": "test0223", "truncated": false, "prefix": "", "marker": "", "maxKeys": 1000, "delimiter": null, "nextMarker": null, "location": "cn-north-7", "extenedCommonPrefixes": [], "objects": [ { "bucketName": "test0223", "objectKey": "test0424.txt", "owner": { "displayName": null, "id": "0ab78f256080d2890feac0086234d7c0" }, "metadata": { "responseHeaders": {}, "originalHeaders": {}, "statusCode": 0, "lastModified": "2024-04-24T06:51:46.566+00:00", "contentLength": 19, "contentType": null, "contentEncoding": null, "contentDisposition": null, "cacheControl": null, "contentLanguage": null, "expires": null, "etag": "\"0b26e313ed4a7ca6904b0e9369e5b957\"", "contentMd5": null, "crc64": null, "storageClass": "STANDARD", "webSiteRedirectLocation": null, "nextPosition": -1, "appendable": false, "objectStorageClass": "STANDARD", "allMetadata": {}, "metadata": {}, "requestId": "" }, "objectContent": null } ], "requestId": "0000018F0EEE84734012ACF15A46395E" } 数据映射输出结果为：

配置参数 参数 说明 源端数据源 设置源端数据源，数据库类型的数据源在选择完表之后会自动显示字段信息，其他格式的数据源需要通过导入文件或者手动增加的形式来添加字段。导入的文件目前主要支持json，xml和csv格式导入。 目的端数据源 设置目的端数据源，数据库类型的数据源在选择完表之后会自动显示字段信息，其他格式的数据源需要通过导入文件或者手动增加的形式来添加字段。导入的文件目前主要支持json，xml和csv格式导入。 如果后续节点想要引用“数据映射”处理器的输出数据，可通过${节点id|payload.xxx}的形式来引用。节点id可通过单击“数据映射”处理器获取到。

创建MySQL连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“MySql”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 区域 选择区域。 项目 选择项目。 实例 选择实例，用于后续验证连通性。 连接与安全 选择数据库的连接模式。当前支持“默认”模式，由系统根据用户配置自动拼接数据源连接字符串。 主机IP地址 填写数据库的连接IP地址。 端口 填写数据库的连接端口号。 数据库名 填写要连接的数据库名。 用户名 连接数据库的用户名。 密码 连接数据库的用户密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

配置参数 表1 获取记录 参数 说明 表名 填写要查询数据的数据表名。 字段名 填写要查询数据的字段名，多个字段以英文逗号（,）分隔。 WHERE条件 填写要查询数据的条件。 Order by字段 填写返回结果的排序字段。 Limit条数 填写返回结果的每页数据条数。 Offset偏移量 填写分页查询的偏移量。 表2 获取增量记录 参数 说明 表名 填写要查询数据的数据表名。 字段名 填写要查询数据的字段名，多个字段以英文逗号（,）分隔。 WHERE条件 填写要查询数据的条件。 Order by字段 填写返回结果的排序字段。 增量获取时区 增量数据获取开始时区。 增量获取时间戳字段 增量数据获取的时间戳字段。 增量获取时间戳初始值 增量数据获取的时间戳初始值。 重置增量获取时间初始值 选择是否开启重置增量获取时间初始值。 增量获取时间补偿(毫秒） 增量获取补偿增量迁移初始时间戳。 表3 添加记录 参数 说明 表名 填写要插入数据的数据表名。 插入数据 填写插入操作中目标字段的值。 表4 更新记录 参数 说明 表名 填写要更新数据的数据表名。 更新数据 填写更新操作中目标字段的值。 WHERE条件 填写要更新数据的条件。 表5 同步记录 参数 说明 表名 填写要同步数据的数据表名。 清空表 每次同步数据，是否先清空表。 表6 删除记录 参数 说明 表名 填写要删除数据的数据表名。 WHERE条件 填写要删除数据的条件。 表7 自定义SQL 参数 说明 执行语句 填写操作数据库的原生SQL语句。 执行语句内容会明文展示所输入信息，请防止信息泄露。 请谨慎使用drop、truncate等非查询类语句。

配置参数 表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 项目下创建计划 项目下查询测试计划列表 通过用例编号获取测试用例详情 批量更新测试用例结果 批量执行测试用例 更新自定义测试服务类型用例 获取测试用例详情 批量删除自定义测试服务类型用例 创建自定义测试服务类型用例 删除已注册服务 更新已注册服务 新测试类型服务注册 用户获取自己当前已经注册的服务

配置参数 PostgreSQL连接器不支持中文表名，仅支持英文表名。 表1 获取记录 参数 说明 表名 选择或者填写要查询的数据库中的表名。 字段名 选择要查询数据表的字段名。 WHERE条件 配置要查询数据的条件值（注意值要用英文单引号包住）。 Order by字段 填写返回结果的排序字段。 Limit条数 填写返回结果的每页数据条数。 Offset偏移量 填写分页查询的偏移量。 表2 添加记录 参数 说明 表名 选择或者填写数据库中要插入数据的表名。 插入数据 填写插入操作中目标字段的值（注意值要用英文单引号包住）。 表3 更新记录 参数 说明 表名 选择或者填写数据库中要更新数据的表名。 更新数据 填写更新操作中目标字段的值（注意值要用英文单引号包住）。 WHERE条件 配置要更新数据的条件值（注意值要用英文单引号包住）。 表4 同步数据 参数 说明 表名 选择或者填写数据库中要同步数据的表名。 清空表 每次同步数据，是否先清空表。 表5 增量获取记录 参数 说明 表名 选择或者填写要增量获取记录的数据库中的表名。 字段名 选择要查询数据表的字段名。 WHERE条件 配置要查询数据的条件值（注意值要用英文单引号包住）。 Order by字段 填写返回结果的排序字段。 增量获取时区 增量数据获取开始时区。 增量获取时间戳字段 增量数据获取的时间戳字段。 增量获取时间戳初始值 增量数据获取的时间戳初始值。 重置增量获取时间初始值 选择是否开启重置增量获取时间初始值。 增量获取时间补偿(毫秒） 增量获取补偿增量迁移初始时间戳。 表6 删除记录 参数 说明 表名 选择或者填写数据库中要删除数据的表名。 WHERE条件 配置要删除数据的条件值（注意值要用英文单引号包住）。 表7 自定义SQL 参数 说明 执行语句 填写操作数据库的原生SQL语句。 执行语句内容会明文展示所输入信息，请防止信息泄露。 请谨慎使用drop、truncate等非查询类语句。

创建PostgreSQL连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“PostgreSQL”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 区域 选择区域。 项目 选择项目。 实例 选择实例，用于后续验证连通性。 连接与安全 选择数据库的连接模式。 默认：由系统根据用户配置自动拼接数据源连接字符串。 专业：由用户自己输入数据源连接字符串。 主机IP地址 仅当“连接与安全”选择“默认”时需要配置。 填写数据库的连接IP地址。 端口 仅当“连接与安全”选择“默认”时需要配置。 填写数据库的连接端口号。 数据库名 仅当“连接与安全”选择“默认”时需要配置。 填写要连接的数据库名。 连接字符串 仅当“连接与安全”选择“专业”时需要配置。 填写PostgreSQL数据库的JDBC格式连接串，例如：jdbc:postgresql://{hostname}:{port}/{dbname}。 用户名 连接数据库的用户名。 密码 连接数据库的用户密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

创建CodeArts IDE Online连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts IDE Online”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 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 查询IDE实例列表 参数 说明 region_id 区域ID。 limit 每页显示的条目数量，最大值为100，最小值为1。 offset 偏移量，表示从此偏移量开始查询。 is_temporary 是否页面显示（以标签配置为准）。 label 标签。 search 关键字查询(根据实例名，描述模糊查询)。 sort_dir 排序方式 asc/desc。 sort_key 排序字段。 display_name 实例名、status状态、pvc_quantity 存储容量、created_time 创建时间、stack_id 技术栈。 表2 创建IDE实例 参数 说明 org_id 租户ID（对应华为云账号的domainId）。 region_id 区域ID。 agent_id 代理商ID，教程活动场景下使用。 arch cpu架构，x86或arm。 cpu_memory cpu规格。arm架构支持4U8G，x86架构支持1U1G、2U4G、2U8G，与技术栈配置的规格对应，可通过技术栈管理ListStacks接口获取。如果标签不为空，以标签配置的技术栈规格为准。 quantum技术栈，x86架构cpu规格为2U8G；其他技术栈，x86架构cpu规格为1U1G、2U4G。 description 描述。 display_name 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间。 is_temporary 实例标签（不同的第三方需要和CodeArtsIDEOnline服务共同设定标签），不传默认为default。 label_tag 排序方式asc/desc。 plugin_enable_list 预装插件列表。 plugin_vars 预装插件参数，请注意敏感信息保护，若涉及敏感信息，请自行加密。 port_id 云服务器对应的portId，小网连接ecs的场景下使用。 private_ip 云服务器ip，小网连接ecs的场景下使用。 pvc_quantity PVC规格，如5GB|10GB|20GB。 refresh_interval 自动休眠时长。arm架构，自动休眠时长只能设置成30或60。x86架构可取值为30、60、240、1440和-1。除-1外，其它值的单位为“分钟”。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。-1表示实例不会自动停止。 repository_id 解放号的仓库ID，解放号场景下使用。 stack_id 技术栈ID，通过技术栈管理ListStacks接口获取。 task_type 任务类型，教程活动场景下使用。 token 解放号的token，解放号场景下使用。 vpc_id 云服务器对应的vpcId，小网连接ecs的场景下使用。 instance_domain_id 实例授权用户租户ID。 instance_user_id 实例授权用户ID。 表3 查询某个租户下的IDE实例列表 参数 说明 org_id 租户ID（对应华为云账号的domainId）。 region_id 区域ID。 is_temporary 实例标签（不同的第三方需要和CodeArtsIDEOnline服务共同设定标签），不传默认为default。 limit 每页显示的条目数量，10/15/30。 offset 偏移量，表示从此偏移量开始查询。 search 关键字查询(根据实例名，描述模糊查询)。 表4 停止IDE实例 参数 说明 instance_id 实例ID。 region_id 区域ID。 表5 启动IDE实例 参数 说明 instance_id 实例ID。 region_id 区域ID。 plugin_enable_list 插件列表。 plugin_vars 插件参数，请注意敏感信息保护，若涉及敏感信息，请自行加密。 表6 删除IDE实例 参数 说明 instance_id 实例ID。 region_id 区域ID。 表7 修改IDE实例 参数 说明 instance_id 实例ID。 region_id 区域ID。 description 描述。 display_name 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间。 refresh_interval 自动休眠时长。arm架构，自动休眠时长只能设置成30或60。x86架构可取值为30、60、240、1440和-1。除-1外，其它值的单位为“分钟”。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。-1表示实例不会自动停止。 表8 查询某个IDE实例 参数 说明 instance_id 实例ID。 region_id 区域ID。 表9 查询IDE实例名是否重复 参数 说明 region_id 区域ID。 display_name 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间。

响应示例 状态码： 200 OK { "total" : "658,", "size" : "1,", "entities" : [ { "datasource_id" : "acd5502992254b3ab2dfd5b6900159db", "datasource_name" : "TY_KAFKA", "datasource_type" : "KAFKA", "content" : { "project_id" : "c53626012ba84727b938ca8bf03108ef", "type" : "KAFKA", "instance_id" : "05173009-2e5f-4773-8303-8e05cc9c9302", "broker" : "10.01.01.01:9092", "ssl_username" : "1", "ssl_password" : "******", "ssl_enable" : true }, "create_time" : 1616784907101, "update_time" : 1619650507230, "app_id" : "141bbdf5-131e-4111-898d-5a6292a2113b", "app_name" : "app-zhe", "instance_id" : "05173009-2e5f-4773-8303-8e05cc9c9302", "remark" : "No change.", "app_permission" : [ "read", "access", "delete", "modify" ] } ] }

响应示例 状态码： 200 OK { "total" : 1, "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3", "users" : [ { "id" : "string", "name" : "string", "roles" : [ "read, access, delete, modify, admin" ] } ] } 状态码： 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 total Integer 应用的总成员数量。 id String 应用ID。 users Array of users objects 用户成员列表。 表6 users 参数 参数类型 描述 id String 用户ID。 name String 用户名称。 roles Array of strings 应用权限角色。 read：应用下资源只读权限，至少要存在此权限，包括API调试。 access：应用下资源的访问管理权限。 delete：应用下资源的删除权限。 modify：应用下资源的修改权限，包括API发布、下线。 admin：应用和应用下资源的权限。 仅提供admin时，会自动应用其它所有权限。 未提供read时会自动应用read权限。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 users 否 Array of User objects 要添加的用户成员列表，空列表时代表清空应用的所有成员。 表4 User 参数 是否必选 参数类型 描述 id 否 String 用户ID。 roles 否 Array of strings 应用权限角色。 read：应用下资源只读权限，至少要存在此权限，包括API调试。 access：应用下资源的访问管理权限。 delete：应用下资源的删除权限。 modify：应用下资源的修改权限，包括API发布、下线。 admin：应用和应用下资源的权限。 仅提供admin时，会自动应用其它所有权限。 未提供read时会自动应用read权限。

响应示例 状态码： 201 Created { "product_template_id" : null, "product_id" : 122893, "service_id" : 10190, "service_name" : "s1", "description" : null, "status" : 0, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "created_datetime" : 1607502702474, "last_updated_datetime" : 1607572282845 } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-services.saveService]. Parameter is [X-Auth-Token]. Processor is [header].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "SCB.00000000", "error_msg" : "Not Found", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 product_template_id Integer 服务归属的产品模板ID。 最小值：1 最大值：99999999999999999 product_id Integer 服务归属的产品ID。 最小值：1 最大值：99999999999999999 service_id Integer 服务ID。 最小值：1 最大值：99999999999999999 service_name String 服务名称，支持中文、英文大小写、数字、下划线和中划线，长度2-64。 最小长度：2 最大长度：64 description String 服务描述，长度0-200。 最小长度：0 最大长度：200 status Integer 服务状态，0-启用，1-停用。 最小值：0 最大值：10 created_user CreatedUser object 创建时的用户。 last_updated_user LastUpdatedUser object 最后更新时的用户。 created_datetime Long 创建时间，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：99999999999999999 last_updated_datetime Long 最后修改时间，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：99999999999999999 表5 CreatedUser 参数 参数类型 描述 user_id String 用户ID(保留字段，未使用)。 最小长度：0 最大长度：64 user_name String 用户名。 最小长度：0 最大长度：64 表6 LastUpdatedUser 参数 参数类型 描述 user_id String 用户ID(保留字段，未使用)。 最小长度：0 最大长度：64 user_name String 用户名。 最小长度：0 最大长度：64 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 product_template_id 否 Integer 服务归属的产品模板ID，产品模板ID和产品ID二选一必填，自动向下取整。 最小值：1 最大值：99999999999999999 product_id 否 Integer 服务归属的产品ID，产品模板ID和产品ID二选一必填，自动向下取整。 最小值：1 最大值：99999999999999999 service_name 是 String 服务名称，支持中文、英文大小、数字、下划线和中划线，长度2-64。 最小长度：2 最大长度：64 description 否 String 服务描述，长度0-200。 最小长度：0 最大长度：200 status 是 Integer 服务状态，0-启用，1-停用。 最小值：0 最大值：10

响应示例 状态码： 200 OK { "variables" : [ { "variable_value" : "8080", "env_id" : "cca3616af3684b329064b2a631cb3eeb", "group_id" : "73c58022f20d495aa18885d718647f09", "id" : "09ab8135722440b9bf5d107f2a09d409", "variable_name" : "port" }, { "variable_value" : "192.168.1.5", "env_id" : "7a1ad0c350844ee69479b47df9a881cb", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "id" : "25054838a624400bbf2267cf5b3a3f70", "variable_name" : "address" } ], "total" : 2, "size" : 2 } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 variables Array of EnvVariableInfo objects 本次返回的环境变量列表 表5 EnvVariableInfo 参数 参数类型 描述 variable_value String 变量值支持英文字母、数字、英文格式的下划线、中划线，斜线（/）、点、冒号，1 ~ 255个字符。 env_id String 环境编号 最小长度：1 最大长度：65 group_id String API分组编号 最小长度：1 最大长度：65 variable_name String 变量名，支持英文字母、数字、英文格式的下划线、中划线，必须以英文字母开头，3~32个字符。在API定义中等于#Name的值#部分（区分大小写），发布到环境里的API被变量值替换。 说明： 中文字符必须为UTF-8或者unicode编码。 id String 环境变量编号 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "users" : [ { "name" : "chenjunjie", "id" : "06d9106f3b000f241f83c010d6b78c81" }, { "name" : "fdi-dm", "id" : "076d742f028025191fe9c0109200f5c8" } ] } 状态码： 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 users Array of CandidatesUser objects 候选用户成员列表。 表5 CandidatesUser 参数 参数类型 描述 name String 用户名称。 id String 用户ID。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 字典ID。 name String 字典名称。 字符集：中文、英文字母、数字、下划线和空格。 约束：实例下唯一。 remark String 字典描述。 code String 字典编码。 字符集：英文字母、数字、下划线和空格。 约束：实例下唯一。 extend_one String 字典扩展字段1。 字符集：中文、英文字母、数字、下划线和空格。 extend_two String 字典扩展字段2。 字符集：中文、英文字母、数字、下划线和空格。 parent_code String 父字典编码，为空时代表自身就是最顶级字典。 type String 字典类型。 system: 代表系统内置字典，用户可编辑但不可删除。 user: 代表用户创建字典。 create_time String 创建时间。 update_time String 更新时间。 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

响应示例 状态码： 200 OK { "id" : "string", "name" : "string", "remark" : "string", "code" : "string", "extend_one" : "string", "extend_two" : "string", "parent_code" : "string", "type" : "system", "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z" } 状态码： 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

响应示例 状态码： 200 OK { "name" : "MyDict", "code" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3" } 状态码： 403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" } 状态码： 404 Not Found { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }