华为云用户手册

响应示例 状态码：200 OK { "value" : [ { "name" : "功能自动化", "type" : 6, "execute_type" : 1 }, { "name" : "WebUI自动化", "type" : 8, "execute_type" : 1 }, { "name" : "性能自动化", "type" : 11, "execute_type" : 0 }, { "name" : "车BU功能自动化", "type" : 32, "execute_type" : 1 }, { "name" : "ticc 工程", "type" : 100, "execute_type" : 1 } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 value Array of DomainVisibleServiceVo objects 实际的数据类型：单个对象，集合 或 NULL 表4 DomainVisibleServiceVo 参数 参数类型 描述 name String 第三方服务名 type Integer 第三方服务类型 execute_type Integer 第三方服务执行方式（0：普通TestHub，1：对接八爪鱼TestHub） 状态码：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 参数解释: 业务失败的提示内容 取值范围: 不涉及

URI GET /GT3KServer/v4/{project_id}/visible-services 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于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" : "认证信息过期" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 data Object 返回体 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" : "22347a24b5f9413884fd29e899c8ccfb", "name" : "1", "project_id" : "76667cb543a14cacac2ade913ca44a47", "create_time" : "2025/01/10 11:04:28 GMT+08:00", "creator_name" : "user", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "update_name" : null, "update_num" : null, "update_time" : null, "asset_id" : "1077eddd0e304c5c977c5fae4cc266a7", "parent_id" : "-1", "factor_cnt" : 0 } ], "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

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

请求示例 根据条件分页获取测试用例对象 post https://{endpoint}/v2/b94c9a6947a44597891e0a7362e7383f/testcases/page { "params" : { "mindmap_id" : "ba2725c5b72c4ec18214736ceb99f3d7", "offset" : 1, "limit" : 10 } }

响应示例 状态码：200 OK { "code" : "success", "data" : { "total" : 1, "list" : [ { "id" : "F0963D239A4E49219860EDC0741D7122", "prerequisite" : "", "url" : null, "uri" : "", "deleted" : "no", "create_time" : "2025/01/10 11:00:45 GMT+08:00", "creator_name" : "昵称xxx1111144445454545", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "update_name" : "昵称xxx1111144445454545", "update_num" : "efdb403066474ab08836b9eeaaa23bca", "update_time" : "2025/01/10 11:00:45 GMT+08:00", "case_name" : "子主题", "test_procedure" : "", "expected_results" : "", "operation_and_expected_result" : null, "case_design_desc" : null, "case_num" : null, "auto_type" : "true", "test_case_level" : "2", "node_id" : "7B3E87D771504220A2B9C757E6AC42E1", "mindmap_id" : "fb6bd82a6c084fdab0d8e5d8f820eabc", "is_archive" : false, "extra_param" : "{\"tcStatus\":\"init\"}", "project_id" : "76667cb543a14cacac2ade913ca44a47", "factor_combination_json" : null, "batch_id" : null, "service_id" : null, "branch_id" : null, "plan_id" : null } ], "offset" : 1, "limit" : 10, "pages" : 1, "size" : 1 }, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 code String 参数解释： 错误码 data BasePageInfoTestCase object 返回体 message String 参数解释： 错误信息 表6 BasePageInfoTestCase 参数 参数类型 描述 limit Integer 参数解释： 每页显示的条目数量，最大支持200条 list Array of TestCase objects 返回体 offset Integer 参数解释： 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 pages Integer 参数解释： 总页数量 size Integer 参数解释： 列表个数 total Long 总数 表7 TestCase 参数 参数类型 描述 auto_type String 自动化类型 case_design_desc String 用例设计描述 case_name String 参数解释： 用例名称 取值范围： 大小写字母、数字、符号、中文。 长度限制1-10000位 case_num String 用例编号 create_time String 参数解释： 创建时间 creator_name String 创建人名字 creator_num String 参数解释： 创建者，用户在 IAM 中的ID。 取值范围： 大小写字母、数字。 长度限制固定32位 deleted String 删除状态 expected_results String 预期结果 extra_param String 额外模板字段：以json形式存储，前台解析 factor_combination_json String 因子组合json operation_and_expected_result String 操作及预期结果 id String id 主键 is_archive Boolean 参数解释： 是否归档 取值范围： 0，表示未归档。 1，表示已归档。 mindmap_id String 参数解释： 脑图ID 取值范围： 大小写字母、数字。 长度限制固定32位 node_id String 参数解释： 节点ID 取值范围： 大小写字母、数字。 长度限制固定32位 batch_id String 批次id branch_id String 分支ID plan_id String 计划ID prerequisite String 用例前置步骤 test_case_level String 测试用例级别 test_procedure String 测试步骤 update_name String 更新人名字 update_num String 更新人工号 update_time String 参数解释： 更新时间 url String url uri String uri project_id String 参数解释： 项目ID 取值范围： 大小写字母、数字。 长度限制固定32位 service_id String 服务id 状态码：400 表8 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表9 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

请求参数 表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列表

响应示例 状态码：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" : "认证信息过期" }

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

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 data Object 返回体 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" : null, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

响应示例 状态码：200 获取DNS配置成功 { "status" : "success", "result" : { "dns" : [ { "ips" : [ "128.0.0.0" ], "domain_name" : "www.example.com" } ] }, "reason" : null, "error" : null, "code" : null, "costTimeResult" : null }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 error CommonResponseErrorOfAPITest object 错误详情 reason String 参数解释 错误原因 result DnsMapping object DNS配置结果集 status String 参数解释 状态值，如success、error code String 参数解释 错误码 costTimeResult String 参数解释 提交耗时 表4 CommonResponseErrorOfAPITest 参数 参数类型 描述 code String 参数解释 接口调用失败错误码 reason String 参数解释 接口调用失败原因 表5 DnsMapping 参数 参数类型 描述 dns Array of DnsMappingNode objects 参数解释 DNS配置结果集 表6 DnsMappingNode 参数 参数类型 描述 domain_name String 参数解释 域名 信息 ips Array of strings 参数解释 域名对应的IP 状态码：401 Unauthorized 状态码：403 Forbidden 状态码：404 Not Found

响应示例 状态码：200 OK { "code" : "success", "data" : { "total" : 1, "list" : [ { "id" : "AEDB00C15B8149A39A6B3821EF58BE80", "app" : null, "name" : "子主题", "status" : "", "deleted" : "no", "create_time" : "2025/01/10 10:59:16 GMT+08:00", "creator_name" : "昵称xxx1111144445454545", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "update_time" : "2025/01/10 10:59:16 GMT+08:00", "mindmap_id" : "fb6bd82a6c084fdab0d8e5d8f820eabc", "node_id" : "CE7450D9DD284883BD9EB0A93CE87AE3", "status_type" : "auto", "tc_counts" : "{\"passCases\":0,\"failCases\":0,\"allCases\":0}", "test_cases" : "[]", "delete_time" : null } ], "offset" : 1, "limit" : 10, "pages" : 1, "size" : 1 }, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

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

请求示例 根据条件分页获取场景对象 post https://{endpoint}/v2/b94c9a6947a44597891e0a7362e7383f/scenes/page { "params" : { "mindmap_id" : "b706c2abcc4748f8bb885d0787a81c3e", "offset" : 1, "limit" : 10 } }

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

响应示例 状态码：200 OK [ { "service_id" : "1234567abc", "fail_alert_count" : 0, "block_alert_count" : 0, "timeout_alert_count" : 0, "exception_alert_count" : 0, "statistics_time" : 1745823600000 } ] 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of AlertStatisticsDto objects 告警类型次数统计结果 表5 AlertStatisticsDto 参数 参数类型 描述 block_alert_count Integer 阻塞告警次数 exception_alert_count Integer 异常告警次数 fail_alert_count Integer 失败告警次数 service_id String 服务id statistics_time Long 统计时间 timeout_alert_count Integer 超时告警次数 状态码：201 Created 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 end_time 否 Long 结束时间 start_time 否 Long 开始时间

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 error CommonResponseErrorOfobject object 错误详情 result QueryCasesStatusResponseV2 object DNS配置结果集 status String 状态值，如success、error 表5 CommonResponseErrorOfobject 参数 参数类型 描述 code String 错误码 reason String 错误原因 表6 QueryCasesStatusResponseV2 参数 参数类型 描述 casesStatusJA Array of objects 用例状态数据 状态码：201 Created 状态码：401 Unauthorized 状态码：403 Forbidden 状态码：404 Not Found

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of strings 创建任务请求参数

响应示例 状态码：200 批量获取用例状态数据成功 { "status" : "success", "result" : { "casesStatusJA" : [ { "caseId" : "v91j0000vl6b2b2e", "latestTime" : "2024-06-21 14:09:54", "successTimes" : 0, "executeTimes" : 1, "totalExecuteTimes" : 1, "executeDuration" : "00:00:01.108", "result" : "0", "status" : "success" } ] }, "error" : null }

响应示例 状态码：200 OK { "list" : [ { "id" : "63e80a38674e49889a7de3ab158b804d", "name" : "qqdqdqw", "data_type" : "0", "view_type" : "0", "service_id" : "c2d63f9d3af34177ab62545d841c78d7", "task_type" : "1", "task_ids" : [ "1c4eaa68592b4898b2fe887838072226" ], "create_user" : "efdb403066474ab08836b9eeaaa23bca", "create_time" : 1705596655000, "update_user" : "efdb403066474ab08836b9eeaaa23bca", "update_time" : 1705596655000 } ], "page_num" : 1, "page_size" : 6, "total_page" : 1, "total_size" : 4 } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

URI GET /v2/projects/{service_id}/dashboards 表1 路径参数 参数 是否必选 参数类型 描述 service_id 是 String 参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 看板名称，精确匹配 page_number 否 Integer 页码 page_size 否 Integer 每页数量

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 list Array of DashboardDto objects 返回结果 page_num Integer 页码 page_size Integer 分页大小 total_page Integer 总页数 total_size Long 总条数 表5 DashboardDto 参数 参数类型 描述 create_time Long 创建时间 create_user String 创建者 data_type String 数据类型：0=用例成功率；1=用例时长 id String 唯一ID，主键 name String 看板标题 service_id String 服务ID task_ids Array of strings 任务ID列表 task_type String 任务类型，仅支持持续拨测和冒烟测试 update_time Long 修改时间 update_user String 修改者 view_type String 看板类型：0=折线图；1=散点图；2=饼图 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因