华为云用户手册

响应示例 状态码：200 OK { "total" : 1, "value" : [ { "uri" : "v901000107paa4eo", "type" : "TestVersion", "author" : "85f7cd3cd8784307a5bb194321bef3c1", "name" : "计划1", "version" : "基线_版本", "owner" : "85f7cd3cd8784307a5bb194321bef3c1", "creator" : "85f7cd3cd8784307a5bb194321bef3c1", "iterations" : "[]", "region" : { "region" : null }, "last_modifier" : "85f7cd3cd8784307a5bb194321bef3c1", "last_modified" : "2025-02-26 10:55:32", "last_modified_timestamp" : 1740538532000, "last_change_time" : "2025-02-26 10:55:32", "version_uri" : "v901000106dij34m", "parent_uri" : "v901000106dij34m", "parent_path" : "/761e569574894180b3ecadc9d9df52b6/v901000106dij34m/", "creation_version_uri" : "v901000106dij34m", "creation_date" : "2025-02-07 15:44:59", "creation_date_timestamp" : 1738914299000, "author_name" : "wtt_apitest", "is_master" : 0, "is_iterator" : 1, "plan_start_date" : "2025-02-07 00:00:00", "plan_end_date" : "2025-02-28 23:59:59", "service_id" : "761e569574894180b3ecadc9d9df52b6", "service_name" : "APITest（勿删）", "schema_no" : 9, "owner_name" : "wtt_apitest", "creator_name" : "wtt_apitest", "current_stage" : "execute", "service_types" : "[\"0\",\"1\",\"12\",\"7\",\"8\"]", "risk_rating" : 0, "project_uuid" : "761e569574894180b3ecadc9d9df52b6", "pi_id" : "notSelected", "start_date" : "2025-02-07", "start_date_timestamp" : 1738857600000, "end_date" : "2025-02-28", "end_date_timestamp" : 1740758399000, "actual_start_date" : "2025-02-07", "actual_start_date_timestamp" : 1738914359000, "is_expired" : "0", "expired_info" : "即将超期", "stages" : [ "design", "execute", "report" ], "design" : { "issue_num" : 2, "issue_cover_num" : 2, "case_num" : 3 }, "execute" : { "execute_case_num" : 3, "defect_num" : 2, "completed_defect_num" : 0, "case_success_rate" : "66.7%", "case_execution_rate" : "100.0%" }, "report" : { "case_success_rate" : "66.7%", "case_complete_rate" : "66.7%" }, "branch_uri" : "v901000106dij34m", "branch_name" : "基线" } ], "page_size" : 10, "page_no" : 1 }

请求示例 POST https://{endpoint}/GT3KServer/v4/iterators/batch-query { "project_uuid" : "761e569574894180b3ecadc9d9df52b6", "branch_uri" : "v901000106dij34m", "name" : "计划1", "current_stage" : "", "page_no" : 1, "page_size" : 10 }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of IteratorVersionSummaryVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 IteratorVersionSummaryVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 version String 待测版本 owner String 处理者ID creator String 创建人ID iterations String 关联迭代 description String 描述 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 last_change_time String 最后变更时间 version_uri String 版本URI origin_uri String 源资源URI parent_uri String 父资源URI parent_path String 父资源路径 creation_version_uri String 创建版本URI creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 comment String 备注 number String 编号 is_master Integer 是否为Master分支 is_iterator Integer 是否为迭代 plan_start_date String 开始时间 plan_end_date String 结束时间 service_id String 微服务ID service_name String 微服务名 pbi_id String PBI ID pbi_name String PBI信息 plan_id String 计划ID metric_pbi_ids String 度量PBI ID metric_pbi_id_names String 度量PBI名称 last_syn_date String 最后同步时间 is_closed String 版本是否关闭 asyn_git String 是否同步git库 schema_no Integer schema编号 finish_date String 迭代实际完成时间 owner_name String 处理者名称 creator_name String 创建人名称 current_stage String 当前所处阶段 service_types String 服务类型 risk_rating Integer 风险等级 risk_des String 风险描述 project_uuid String 项目ID domain_id String 租户ID pi_id String pi的id start_date String 计划开始时间 start_date_timestamp Long 计划开始时间时间戳 end_date String 计划结束时间 end_date_timestamp Long 计划结束时间时间戳 actual_start_date String 实际开始时间 actual_start_date_timestamp Long 实际开始时间时间戳 actual_end_date String 实际完成时间 actual_end_date_timestamp Long 实际开始时间时间戳 is_expired String 是否超期 expired_info String 计划过期信息,空代表不超期，否则给出具体超期信息 stages Array of strings 迭代计划，默认包含design,execute,report design DesignSummaryVo object 设计阶段信息汇总 execute ExecuteSummaryVo object 执行阶段信息汇总 report ReportSummaryVo object 报告阶段信息汇总 branch_uri String 所属分支URI branch_name String 所属分支名称 表7 DesignSummaryVo 参数 参数类型 描述 issue_num Integer 需求总数 issue_cover_num Integer 已覆盖需求数 case_num Integer 用例数 表8 ExecuteSummaryVo 参数 参数类型 描述 execute_case_num Integer 已执行用例数 defect_num Integer 缺陷总数 completed_defect_num Integer 已完成缺陷数 case_success_rate String 测试用例通过率 case_execution_rate String 用例执行率 表9 ReportSummaryVo 参数 参数类型 描述 case_success_rate String 用例通过率 case_complete_rate String 用例完成率 状态码：400 表10 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表11 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表12 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表13 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

响应参数 状态码：200 表7 响应Body参数 参数 参数类型 描述 status String 参数解释: 本次请求的处理状态 取值范围: success|error result ResultValueString object 参数解释: 请求结果 取值范围: 非必返 error ApiError object 参数解释: 错误信息 取值范围: 非必返 request_id String 参数解释: 请求的唯一id 取值范围: 非必返 address String 参数解释: 本次请求的受理的服务地址。 取值范围: 非必返 表8 ResultValueString 参数 参数类型 描述 value String 参数解释 resultObject 取值范围 不涉及 表9 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求示例 更新测试套任务 put https://{endpoint}/v4/300c6295a54c4c698608c878f47ddd59/tasks/v91j0000vldlep5u { "description" : "", "name" : "样例功能套件", "owner_id" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "tags" : [ "tag1" ], "number" : "002", "service_type" : 0, "status_code" : "0", "module_name" : "", "release_dev" : "", "execute_way" : 1, "version_uri" : "v91j0000vldleodb", "plan_start_timestamp" : -1, "plan_end_timestamp" : -1 }

URI PUT /v4/{project_id}/tasks/{task_uri} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 task_uri 是 String 任务uri

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 uri 否 String 指定创建任务的uri name 否 String 名称 stage 否 String 测试阶段 number 否 String 编号 tags 否 String 标记id description 否 String 描述 region 否 String 区域 version_uri 否 String 分支/迭代uri owner_id 否 String 处理人/责任人id parent_uri 否 String 父任务uri test_case_condition 否 String 动态任务用例过滤条件 service_type 否 Integer 服务类型0:功能测试 1:接口测试 11:性能测试 module_id 否 String 模块id module_name 否 String 模块名称 release_dev 否 String 发布版本号 status_code 否 Integer 状态code ext_param 否 String 扩展参数 execute_way 否 Integer 执行方式 1：串行，2：并行 execute_type 否 Integer 执行类型（0：冒烟，1：定时） plan_start_timestamp 否 Long 计划开始时间戳，当传入-1时，时间置为空 plan_end_timestamp 否 Long 计划结束时间戳，当传入-1时，时间置为空 assign_case_uris 否 Array of strings 任务关联用例uri数组，CloudDragon环境 case_operation_info 否 CaseOperationInfo object 任务关联用例信息 only_update_status 否 Boolean 是否只需要修改测试套状态 is_async 否 Boolean 是否异步 changes 否 Array of ResourceChangeInfo objects 自定义字段的更新记录 表4 CaseOperationInfo 参数 是否必选 参数类型 描述 empty 否 Boolean 是否为空 test_cases_info 否 Array of AssignCaseInfo objects 用例关联信息 set_up_cases_info 否 Array of AssignCaseInfo objects 前置用例关联信息 tear_down_cases_info 否 Array of AssignCaseInfo objects 后置用例关联信息 表5 AssignCaseInfo 参数 是否必选 参数类型 描述 case_uri 否 String 用例uri is_available 否 Integer 是否可用 表6 ResourceChangeInfo 参数 是否必选 参数类型 描述 field_name 否 String 字段名称 old_value 否 String 旧的value new_value 否 String 新的value old_key 否 String 旧的key new_key 否 String 新的key

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueCustomizedFilterVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表5 ResultValueCustomizedFilterVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value CustomizedFilterVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 CustomizedFilterVo 参数 参数类型 描述 uri String 自定义过滤器URI name String 自定义过滤器名称 filter String 过滤器内容 type Integer 过滤器类型（1：设计页功能用例，2：设计页接口用例 ，3：执行页功能用例 ，4：执行页接口用例） updator String 更新人 region String 逻辑Region service_type Integer 服务类型 stage_type Integer 阶段过程（2：测试设计，3：测试执行，4：质量报告） user_id String 用户ID creator String 创建人 create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 project_id String 项目ID 表7 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求示例 新增自定义过滤器 post https://{endpoint}/v4/projects/3d2378e0fc504c638f48b21377d6add1/filters { "filter_content_info" : { "results" : [ -2 ] }, "name" : "未执行用例", "service_type" : -1, "stage_type" : "2" }

响应示例 状态码：200 OK { "status": "success", "result": { "value": { "uri": "v91k0000vrroldin", "name": "自定义1", "filter": "{\"moduleIds\":[\"undefined\"]}", "updator": "efdb403066474ab08836b9eeaaa23bca", "region": "cn-north-7", "service_type": -1, "stage_type": 2, "user_id": "efdb403066474ab08836b9eeaaa23bca", "creator": "efdb403066474ab08836b9eeaaa23bca", } } }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueListResourceHistoryVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表6 ResultValueListResourceHistoryVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of ResourceHistoryVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 错误信息 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表7 ResourceHistoryVo 参数 参数类型 描述 uri String 资源历史记录Uri author String 资源历史记录创建人 region String 逻辑region changes Array of ResourceChangeVo objects 资源历史记录字段变更列表 resource_uri String 资源uri resource_type String 资源类型 version_uri String 分支/迭代uri creation_date String 创建时间 create_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 not_empty Boolean 非空 project_id String 项目id 表8 ResourceChangeVo 参数 参数类型 描述 only_new_value Boolean 只展示新值 field_name String 变更字段 old_value String 旧值 old_tracker_name String 旧工作项类型 new_tracker_name String 新工作项类型 new_value String 新值 old_key String 原key new_key String 新key old_object_value Object 旧对象值 new_object_value Object 新对象值 old_object_key Object 新object key new_object_key Object 新object key old_tracker_names Object 旧tracker_names new_tracker_names Object 新旧tracker_names old_board_info Array of JSONObject objects 变更前归属看板信息，用例关联工作项信息使用 new_board_info Array of JSONObject objects 变更后归属看板信息，用例关联工作项信息使用 old_display_ids Array of strings 老值，用于前端展示。IPD和Xboard项目的需求和缺陷sequenceId列表，非IPD和Xboard项目的需求和缺陷Id列表。由于需求只能关联一个，所以需求取第一个值 new_display_ids Array of strings 新值，用于前端展示。IPD和Xboard项目的需求和缺陷sequenceId列表，非IPD和Xboard项目的需求和缺陷Id列表。由于需求只能关联一个，所以需求取第一个值 old_test_item_path_name String 变更前路径（目录名称路径） new_test_item_path_name String 变更后路径（目录名称路径） custom_field_type String 测试用例自定义字段类型 表9 JSONObject 参数 参数类型 描述 empty Boolean 是否为空 additionalProperties Object 变更后归属看板信息，用例关联工作项信息使用 表10 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求示例 获取资源修改历史记录 post https://{endpoint}/v4/resources/v91j0000vq997opk/histories/batch-query { "page_no" : 1, "project_uuid" : "30649eb093c2479d92c74c75d36ef280", "version_uri" : "v91i0000vq98suq1", "page_size" : 10, "type" : "TestCase" }

响应示例 状态码：200 OK { "status" : "success", "result" : { "total" : 2, "value" : [ { "uri" : "v9210000vrmhplil", "author" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "region" : "cn-north-7", "changes" : [ { "field_name" : "defectId", "old_key" : "", "new_key" : "8444611", "new_object_value" : [ "用例3新建" ], "new_object_key" : [ "8444611" ], "new_tracker_names" : [ "Bug" ], "new_board_info" : [ ], "new_display_ids" : [ "8444611" ] } ], "resource_uri" : "v91j0000vq997opk", "resource_type" : "TestCase", "version_uri" : "v91i0000vq98suq1", "creation_date" : "2024-09-10 10:49:43", "create_date_timestamp" : 1725936583000, "author_name" : "xxx" }, { "uri" : "v91i0000vrmh72fb", "author" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "region" : "cn-north-7", "changes" : [ { "field_name" : "svnScriptPath", "new_value" : "fail1.py" } ], "resource_uri" : "v91j0000vq997opk", "resource_type" : "TestCase", "version_uri" : "v91i0000vq98suq1", "creation_date" : "2024-09-10 10:39:34", "create_date_timestamp" : 1725935974000, "author_name" : "xxx" } ], "page_size" : 10, "page_no" : 1 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 conditions 否 Array of SearchCondition objects 搜索条件 type 否 String 资源类型 useOffset 否 Boolean 是否使用offset分页 project_uuid 否 String 项目ID version_uri 否 String 分支/迭代uri page_no 否 Integer 页码 page_size 否 Integer 每页展示条数 表4 SearchCondition 参数 是否必选 参数类型 描述 field_name 否 String 字段名 field_value 否 String 字段值 operator 否 String 数据库字段操作 sour_value 否 String 源值 tar_value 否 String 目标值 field_type 否 String 字段类型

请求示例 post https://{{endpoint}}/testrelation/v4/testcases/3fc2130c00/relations { "relations" : [ { "dr_number" : "3325606", "test_case_uri" : "223685", "relate_type" : "bug/requirement", "resource_type" : "testcase/testitem", "source_system" : "vision", "association_number" : "223685", "region" : "szv" } ], "tracker_id" : "1", "version_uri" : "932opbu6aaf", "task_uri" : "59281152185", "add_to_iterator" : true, "project_uuid" : "223685eqweqwe1112w" }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 status String 参数解释 success|error; 取值范围 success|error result ResultValueStringForOk object 请求结果 表6 ResultValueStringForOk 参数 参数类型 描述 value String 参数解释 ok 取值范围 不涉及 状态码：400 表7 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表10 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 relations 否 Array of RelationInfo objects 关联关系 tracker_id 否 String 参数解释 工作项类型id 约束限制 1到20位数字 取值范围 不涉及 默认取值 不涉及 version_uri 否 String 参数解释 版本uri 约束限制 11到34位英文或数字 取值范围 不涉及 默认取值 不涉及 task_uri 否 String 参数解释 测试套id 约束限制 11到34位英文或数字 取值范围 不涉及 默认取值 不涉及 add_to_iterator 否 Boolean 参数解释 是否将需求添加到迭代 约束限制 11到34位英文或数字 取值范围 不涉及 默认取值 不涉及 project_uuid 否 String 参数解释 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制 不涉及 取值范围 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值 不涉及 表4 RelationInfo 参数 是否必选 参数类型 描述 dr_number 是 String 参数解释 需求id 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 test_case_uri 否 String 参数解释 用例uri 约束限制 不涉及 取值范围 11到34位英文或数字 默认取值 不涉及 relate_type 是 String 参数解释 资源类型 约束限制 不涉及 取值范围 bug/requirement 默认取值 不涉及 resource_type 否 String 参数解释 资源类型 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 source_system 否 String 参数解释 来源系统 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 association_number 否 String 参数解释 关联资源编号 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 region 否 String 参数解释 逻辑region，外部使用公有云实际区域，内部使用默认值 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 value Array of UsageInfos objects 资源已用容量对象 表4 UsageInfos 参数 参数类型 描述 name String 资源名称 id String 资源标识 amount String 资源总量 used String 已消耗用量 used_percent Integer 资源已用容量百分比,例如80% 值为80 usage_info Array of UsageInfos objects 版本超限信息 状态码：400 表5 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表6 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表7 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

响应示例 状态码：200 OK { "result" : { "value" : [ { "id" : "DEFAULT", "name" : "DEFAULT", "type" : "DEFAULT", "selected" : "true", "active_state" : "DEFAULT" } ] } }

URI GET /testexecutor/v4/{project_id}/resource-pools 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListResourcePoolVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 表4 ResultValueListResourcePoolVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of ResourcePoolVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 ResourcePoolVo 参数 参数类型 描述 id String 资源池ID name String 资源池名称 type String 资源池类型（VM/DOCKER） selected String 是否选中 active_state String 资源池状态 表6 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表7 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表10 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : [ { "uri" : "v91j0000vrqirl8b", "code" : 0, "name" : "新建", "flag" : 0, "sort" : 1, "type" : "3", "region" : "cn-north-7" }, { "uri" : "v91j0vrqirl8bjh4", "code" : 5, "name" : "设计中", "flag" : 0, "sort" : 2, "type" : "3", "region" : "cn-north-7" }, { "uri" : "v91j0vrqirl8bjh5", "code" : 6, "name" : "测试中", "flag" : 0, "sort" : 3, "type" : "3", "region" : "cn-north-7" }, { "uri" : "v91j0vrqirl8bjh6", "code" : 7, "name" : "完成", "flag" : 0, "sort" : 4, "type" : "3", "region" : "cn-north-7" } ] } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListProjectDefinedStatusConfigVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueListProjectDefinedStatusConfigVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of ProjectDefinedStatusConfigVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 ProjectDefinedStatusConfigVo 参数 参数类型 描述 uri String 资源URI code Integer 数值 name String 名称 position Integer 位置 flag Integer 修改标识，0：不可修改 1：可修改 sort Integer 顺序 type String 自定义配置类型，类型（1:用例状态，2:用例结果，3:测试套状态，4:测试套结果） project_id String 项目ID region String region id 表6 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

URI GET /v4/projects/{project_uuid}/user-defined-configs 表1 路径参数 参数 是否必选 参数类型 描述 project_uuid 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 类型（1:用例状态 2：用例结果 3：测试套状态 4：测试套结果） service_type 否 String 服务类型

URI POST /v4/{project_id}/iterators/{iterator_uri}/defects/batch-query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 iterator_uri 是 String 迭代uri

请求示例 查询迭代下的缺陷信息 post https://{endpoint}/v4/300c6295a54c4c698608c878f47ddd59/iterators/v91j0000vldleodb/defects/batch-query { "page_no" : 1, "page_size" : 6, "key_word" : "", "sort_field" : "", "sort_type" : "" }

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : [ { "name" : "新增的缺陷", "owner" : "xxx", "path" : "8452839", "region" : "cn-north-7", "creator" : "xxx", "project_uuid" : "300c6295a54c4c698608c878f47ddd59", "work_item_id" : "8452839", "status_id" : "1", "status_name" : "新建", "tracker_id" : "3", "tracker_name" : "缺陷", "severity_id" : "12", "severity_name" : "一般", "create_time" : "2024-09-11 11:05:27", "update_time" : "2024-09-11 11:05:27", "have_child_dynamic" : false, "has_child" : false, "issue_dynamic_count" : 0, "case_count" : 0, "sequence_id" : "" } ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 key_word 否 String 关键字 page_size 是 Integer 每页数量 page_no 是 Integer 页码 sort_field 否 String 排序字段 sort_type 否 String 排序类型

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : { "uri" : "v9220000vrro99lu", "creation_date" : "2024-09-12 11:19:18", "creation_date_timestamp" : 1726111158974, "time_cost" : 0, "project_uuid" : "3d2378e0fc504c638f48b21377d6add1" } } }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 uri 否 String 主键 name 否 String 结果名字 description 否 String 描述 result 否 String 用例结果 status 否 String 任务状态 preparation 否 String 前置条件 steps 否 Array of TestCaseStepResultInfo objects 用例步骤结果信息 release_dev 否 String 版本号 task_uri 否 String 任务URI task_result_uri 否 String 测试套结果URI 表3 TestCaseStepResultInfo 参数 是否必选 参数类型 描述 result 否 String 步骤结果值 actual_result 否 String 步骤实际结果 expect_result 否 String 步骤期望结果 test_step 否 String 用例操作步骤