华为云用户手册

响应示例 状态码：200 OK { "code" : "success", "data" : null, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

请求示例 批量查询用例V3 put https://{endpoint}/v3/b94c9a6947a44597891e0a7362e7383f/testcases { "params" : { "mindmap_id" : "b706c2abcc4748f8bb885d0787a81c3e", "node_id" : "61D31C6A2F5548C2A83E3F8A7E531285" } }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 code String 错误码 data Object 返回体 message String 错误信息 状态码：400 表6 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表7 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

响应示例 状态码：200 OK { "code" : "success", "data" : [ { "id" : "821e14b07e4a4621b0ee4920dff2d32e", "prerequisite" : "", "url" : null, "uri" : null, "deleted" : "no", "create_time" : "2024/08/20 10:20:35 GMT+08:00", "creator_name" : "user", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "updator_name" : "--", "updator_num" : null, "update_name" : "--", "update_num" : null, "update_time" : null, "case_name" : "子主题_123", "test_procedure" : null, "expected_results" : null, "operation_and_expected_result" : "[{\"operation\":\"\",\"expected_result\":\"\"}]", "case_design_desc" : "", "case_num" : "", "auto_type" : "true", "test_case_level" : "2", "node_id" : "7B53C0E5810246E682C9713438847FF2", "mindmap_id" : "4600fbce4f9048c4a6455e6e88163b4a", "is_archive" : false, "extra_param" : "{\"tcStatus\":\"init\"}", "project_id" : "0edf40e28ce64bc7936b79896e8ec630", "factor_combination_json" : "{\"combineAlgorithm\":\"BC\",\"子主题\":{\"factor_ids\":[\"50DD38795EF642F48728CEEE8F850F14\"],\"value\":\"123\"},\"$checked\":true,\"combineName\":\"123\",\"$halfChecked\":false}", "batch_id" : "20240820102923_393BE59E", "service_id" : null, "branch_id" : null, "plan_id" : null } ], "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 是 TestCasePageParam object 用例分页参数 表4 TestCasePageParam 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释： 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 limit 否 Integer 参数解释： 每页显示的条目数量，最大支持200条 deleted 否 String 参数解释： 是否删除 取值范围： 1，表示已删除 0，表示未删除 id_collection 否 Array of strings ID集合 mindmap_id 否 String 参数解释： 脑图ID 取值范围： 大小写字母、数字。 长度限制固定32位 node_id 否 String 参数解释： 节点ID 取值范围： 大小写字母、数字。 长度限制固定32位 node_id_collection 否 Array of strings 节点ID集合 project_id 否 String 参数解释： 项目ID 取值范围： 大小写字母、数字。 长度限制固定32位 is_archive 否 Boolean 参数解释： 是否归档 取值范围： 0，表示未归档。 1，表示已归档。 case_name 否 String 参数解释： 用例名称 取值范围： 大小写字母、数字、符号、中文。 长度限制1-10000位 has_sub_mindmap 否 Boolean 参数解释： 是否有子脑图 取值范围： 0，表示无子脑图。 1，表示有子脑图。 sub_mindmap_id 否 Array of strings 子脑图ID列表

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

请求示例 post https://{endpoint}/testrelation/v4/efdb403066474ab08836b9eeaaa23bca/issues/894789325632/testcases/batch-query { "page_no" : 1, "page_size" : 10, "sort_field" : "name", "sort_type" : "DESC", "version_uri" : "858ds8ew2", "relate_type" : "bug/requirement", "key_word" : "keyWord", "rank_ids" : [ "1", "2" ], "result_codes" : [ "0", "1" ] }

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

响应示例 状态码：200 OK { "case_status_map" : { "additionalProp1" : 0, "additionalProp2" : 0, "additionalProp3" : 0 }, "new_create" : 1, "designing" : 1, "finished" : 1, "testing" : 1, "test_case_num" : 1, "testcases" : [ "" ], "total_count" : 1 }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：400 表4 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表5 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

响应示例 状态码：200 OK { "code" : "success", "data" : { "saveTemplate" : true, "deleteMindmapById" : true, "editMindmap" : true, "mindmapBackupBackUpMindmap" : true }, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

响应示例 状态码：200 OK { "code" : "success", "data" : { "total" : 0, "list" : [ ], "offset" : 1, "limit" : 10, "pages" : 0, "size" : 0 }, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 GetDefaultTemplateParam object 请求体 表4 GetDefaultTemplateParam 参数 是否必选 参数类型 描述 name 否 String 参数解释： 脑图模板名称 取值范围： 大小写字母、数字、中文、符号。 长度限制128位

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 code String 参数解释： 错误码 data BasePageInfoTemplate object 返回体 message String 参数解释： 错误信息 表6 BasePageInfoTemplate 参数 参数类型 描述 limit Integer 参数解释： 每页显示的条目数量，最大支持200条 list Array of Template objects 返回体 offset Integer 参数解释： 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 pages Integer 参数解释： 总页数量 size Integer 参数解释： 列表个数 total Long 总数 表7 Template 参数 参数类型 描述 create_time String 参数解释： 创建时间 creator_name String 参数解释： 创建人名称。 取值范围： 大小写字母、数字、符号、中文。 creator_num String 参数解释： 创建者，用户在IAM中的ID。 取值范围： 大小写字母、数字。 长度限制固定32位 description String 描述 id String id 主键 is_default String 是否默认 mindmap String 脑图json name String 名称 update_time String 参数解释： 更新时间 状态码：400 表8 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表9 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

响应示例 状态码：200 OK { "status" : "success", "result" : { "id" : "37df588351464f45944580b288556d37", "warningMsg" : null, "name" : "baidu1", "source" : null, "method" : "getwww_baidu_com", "description" : "自定义URL请求", "nameView" : null, "tmssCaseNumber" : null, "region" : "cn-north-7", "yamlName" : null, "create_time_string" : "2024-06-21 15:46:18 GMT+08:00", "update_time_string" : "2024-06-21 15:46:18 GMT+08:00", "create_time_stamp" : 1718955978000, "update_time_stamp" : 1718955978000, "create_user" : "devcloud_devcloud_s00314720_01", "create_time" : "2024-06-21T03:46:18+0800", "update_user" : "devcloud_devcloud_s00314720_01", "update_time" : "2024-06-21T03:46:18+0800", "param_type_and_dft_value" : [ ], "dft_custom_header" : null, "dft_check_point_list" : [ ], "dft_variable_list" : [ ], "keyword_variable_value" : null, "dft_retry_times" : null, "dft_retry_interval" : null, "return_type" : "[{\"returnCode\":200}]", "aw_type" : 1, "aw_ins_list" : null, "project_id" : "09645c1f3f954a8d9ab29174857cffc5", "public_aw_lib_id" : null, "special_type" : 90, "has_code" : 1, "aw_code" : "", "group_name" : "dfaba6a51f024c1f95229c1059ca34e0", "protocol_type" : "http/https", "by_order" : 1, "aw_mark" : 1, "output_param_list" : null, "is_favorite" : null, "tmss_case_id" : null, "create_user_id" : null, "aw_description" : null, "origin_project" : null, "aw_uniqueid" : null, "aw_tags" : null, "aw_operationid" : null, "interface_label" : null, "import_package" : null, "public_aw_lib" : null, "root_id" : null, "custom_aw_libs" : null, "delete_time" : null, "delete_user" : null, "extra_info" : { "http_method" : "get", "http_url" : "http://www.baidu.com" } }, "reason" : null, "error" : null, "code" : null }

响应参数 状态码：200 表14 响应Body参数 参数 参数类型 描述 code String 参数解释 错误码 error CommonResponseErrorObject object 参数解释 统一错误返回 reason String 参数解释 失败原因 result Object 参数解释 结果 status String 参数解释 响应状态 表15 CommonResponseErrorObject 参数 参数类型 描述 code String 参数解释 错误码 reason String 参数解释 错误原因 状态码：201 Created 状态码：401 Unauthorized 状态码：403 Forbidden 状态码：404 Not Found

请求示例 post https://{endpoint}/v1/09645c1f3f954a8d9ab29174857cffc5/basic-aw { "name" : "baidu2", "group_name" : "dfaba6a51f024c1f95229c1059ca34e0", "description" : "自定义URL请求", "extra_info" : { "http_url" : "http://www.baidu.com", "http_method" : "get" }, "param_type_and_dft_value" : [ ], "dft_check_point_list" : [ ], "dft_variable_list" : [ ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 code String 错误码 data Object 返回体 message String 错误信息 状态码：400 表5 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表6 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

响应示例 状态码：200 OK { "code" : "success", "data" : null, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 表3 FormData参数 参数 是否必选 参数类型 描述 excel_file 是 File 待导入文件 parent_id 是 String 父目录id

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：400 表4 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表5 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

响应示例 状态码：200 OK { "code" : "success", "data" : { "id" : "705ce4b448b9453b97a6eed28273d38c", "mindmap" : "{\"root\":{\"layout\":\"map\",\"shape\":\"box\",\"children\":[{\"side\":\"right\",\"id\":\"F8042788E07242B186AE3872F83584DB\",\"text\":\"子主题\"}],\"id\":\"c9af4aa753a94e85a849f5a60486ca75\",\"text\":\"思维导图\"}}", "memo" : "", "type" : null, "create_time" : "2024/08/20 10:42:32 GMT+08:00", "creator_name" : "user", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "updator_name" : null, "updator_num" : null, "update_name" : null, "update_num" : null, "update_time" : "2024/08/20 10:42:32 GMT+08:00", "bak_name" : "1_172412175275975dfa31a64ae49c49868f09ca3ab76d0", "mindmap_id" : "c9af4aa753a94e85a849f5a60486ca75", "project_id" : "0edf40e28ce64bc7936b79896e8ec630" }, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

响应示例 状态码：200 OK { "status" : "success", "result" : { "total" : 1, "value" : [ { "id" : "v92s00010d5on48h", "name" : "YQTest_UDF_REP", "workpiece_type" : "case", "analysis_dimension" : "STATUS", "chart_data" : [ { "analyze_dim" : { "id" : "0", "name" : "新建", "value" : 3 } } ] } ], "page_size" : 5, "page_no" : 1 } }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 参数解释: success|error 取值范围: 不涉及 result ResultValueListCustomReportListVo object 请求的返回的数据对象 表5 ResultValueListCustomReportListVo 参数 参数类型 描述 total Integer 参数解释: 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 取值范围: 不涉及 value Array of CustomReportListVo objects 参数解释: 实际的数据类型：单个对象，集合 或 NULL 取值范围: 不涉及 reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 CustomReportListVo 参数 参数类型 描述 id String 参数解释: 报表id 取值范围: 不涉及 name String 参数解释: 报表名称 取值范围: 不涉及 filter ReportFilter object 过滤条件 workpiece_type String 工件类型(用例：case,测试套：task) analysis_dimension String 分析维度 compare_dimension String 对比维度 chart_data Array of ReportChartDataVo objects 报表数据 表7 ReportFilter 参数 参数类型 描述 creatorIds String 参数解释: 创建人 取值范围: 不涉及 ownerIds String 参数解释: 所属人 取值范围: 不涉及 ranks String 参数解释: 级别 取值范围: 不涉及 releaseIds String 参数解释: releaseId 取值范围: 不涉及 status String 参数解释: 状态 取值范围: 不涉及 moduleIds String 参数解释: 级别 取值范围: 不涉及 results String 参数解释: 结果 取值范围: 不涉及 labelIds String 参数解释: 标签 取值范围: 不涉及 startTime String 参数解释: 开始时间 取值范围: 不涉及 endTime String 参数解释: 结束时间 取值范围: 不涉及 isAssociateIssue String 参数解释: 是否关联需求 取值范围: 不涉及 表8 ReportChartDataVo 参数 参数类型 描述 id String 报表id name String 报表名称 analyze_dim ReportDimVo object 对比维度数据 compare_dim Array of ReportDimVo objects 对比维度数据 表9 ReportDimVo 参数 参数类型 描述 id String id name String 名称 value Integer 值 状态码：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 参数解释: 业务失败的提示内容 取值范围: 不涉及

URI GET /testreport/v4/{project_id}/versions/{version_id}/custom-reports 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 version_id 是 String 参数解释: 版本id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 page_size 是 Long 参数解释: 每页显示的条目数量,最大支持200条 约束限制: 不涉及 取值范围: 取值范围1-200 默认取值: 不涉及 offset 是 Long 参数解释: 页数，page_no大于等于1值 约束限制: 不涉及 取值范围: 取值范围0-20000 默认取值: 不涉及 type 是 Integer 参数解释: 报表类型 1：首页用例库， 2：质量报告 约束限制: 约束限制：1：首页用例库， 2：质量报告 取值范围: 不涉及 默认取值: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 是 ListFactorParam object 因子查询参数 表4 ListFactorParam 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释： 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 limit 否 Integer 参数解释： 每页显示的条目数量，最大支持200条 type 否 String 参数解释： Action-动作因子 Data-数据因子 name 否 String 参数解释： 因子名称 取值范围： 大小写字母、数字、中文。 长度限制最大500位 parent_node_ids 否 Array of strings 父ID集合 asset_id 否 String 参数解释： 因子库ID。 取值范围： 大小写字母、数字。 长度限制固定32位 creator_num 否 String 参数解释： 创建者，用户在IAM中的ID。 取值范围： 大小写字母、数字。 长度限制固定32位 mindmap_id 否 String 参数解释： 脑图ID 取值范围： 大小写字母、数字。 长度限制固定32位 testpoint_id 否 String 参数解释： 测试点ID 取值范围： 大小写字母、数字。 长度限制固定32位 mindmap_node_id 否 String 参数解释： 脑图节点ID 取值范围： 大小写字母、数字。 长度限制固定32位

响应示例 状态码：200 OK { "code" : "success", "data" : { "total" : 1, "list" : [ { "id" : "c4adb39912674fa081fd95983ea6e98b", "name" : "1", "number" : "457106318256", "type" : "Data", "description" : "", "note" : "", "precondition" : null, "project_id" : "76667cb543a14cacac2ade913ca44a47", "create_time" : "2025/01/10 11:06:28 GMT+08:00", "creator_name" : "user", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "update_name" : null, "update_num" : null, "update_time" : null, "mindmap_id" : null, "asset_id" : "1077eddd0e304c5c977c5fae4cc266a7", "source_id" : null, "parent_id" : "c8ffe24a14f946b28c04356178dc8073", "mindmap_node_id" : null, "testpoint_id" : null, "data_type" : "String", "operation_and_expected_result" : null, "valid_values" : null, "invalid_values" : null } ], "offset" : 1, "limit" : 15, "pages" : 1, "size" : 1 }, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

请求示例 根据目录查询因子 post https://{endpoint}/v1/b94c9a6947a44597891e0a7362e7383f/factor/87704464792d46ddb5b793a35e23296b { "params" : { "offset" : 1, "limit" : 15, "parent_node_ids" : [ "2b551514ffe54550a1a755d9fbfc07e6" ] } }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 code String 错误码 data Object 返回体 message String 错误信息 状态码：400 表6 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表7 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

响应示例 状态码：200 OK { "code" : "success", "data" : null, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }