华为云用户手册

响应示例 状态码：200 OK { "status" : "success", "result" : { "taskId" : "b98e483aecba4fe3b00b0fe484c391ca", "needApprove" : null, "warn" : [ ], "packageType" : "codearts.testplan.china.pro", "isPopup" : false }, "error" : null }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 cases 否 Array of strings 用例列表 functionType 否 String 执行的功能类型："1"表示执行；"2"表示调试 releaseversion 否 String 发布版本号 resourcePool 否 ResourcePool object 资源池 taskName 否 String 任务名称 表4 ResourcePool 参数 是否必选 参数类型 描述 activeState 否 String 活动状态 id 否 String id name 否 String 名称 selected 否 Boolean 是否被选中 type 否 String 类型

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 参数解释 接口返回状态，ok-成功，failed-失败 约束限制 不涉及 取值范围 ok,failed 默认取值 ok result Array of SystemConfigDto objects 服务配置的返回参数 表5 SystemConfigDto 参数 参数类型 描述 comments String 备注 config_key String 配置键 config_type String 配置类型 config_value String 配置值 create_time Long 创建时间 create_user String 创建者 id String UUID test_service_id String 服务id update_time Long 修改时间 update_user String 修改者 状态码：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 错误原因

响应示例 状态码：200 OK 示例 1 "ok" 示例 2 [ { "id" : "1234567890", "create_user" : "echotest", "create_time" : 1609329143000, "update_user" : "echotest", "update_time" : 1609329143000, "test_service_id" : "", "config_type" : "State", "config_key" : "XX", "config_value" : "XXX", "comments" : "状态定义" } ]

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 config_type 否 String 系统配置，服务自己配置{system、service} types 否 Array of strings 配置类型集合

请求示例 post https://{endpoint}/GT3KServer/v4/f3087a82b44744c29a1bd69ab6ada154/iterators/9b26f58ec29943f681804a6628779a23/issues/batch-query { "owner" : "e8ad9e7478c94f4eaf90d5a379af9cb1", "issue_id" : "efdb403066474ab08836b9eeaaa23bca", "page_no" : 1, "page_size" : 1000, "key_word" : "管理", "iteration_id" : "10415967", "severity_id" : "12", "status_id" : "1", "module_id" : "261469", "status_ids" : "1", "module_ids" : "261469", "status_names" : [ "string" ] }

响应示例 状态码：200 OK { "value" : [ { "name" : "Story1", "owner" : "dfc5347b9b16491e942ce55ce7f79dbc", "path" : "1413918,1413919", "region" : { "region" : null }, "creator" : "dfc5347b9b16491e942ce55ce7f79dbc", "updator" : "dfc5347b9b16491e942ce55ce7f79dbc", "project_uuid" : "90f8dc52eb7b4c47b853c661152ca62d", "work_item_id" : "1413919", "status_id" : "1", "status_name" : "新建", "tracker_id" : "7", "tracker_name" : "Story", "severity_id" : "12", "severity_name" : "一般", "parent_workitem_id" : "1413918", "create_time" : "2025-02-28 16:05:21", "update_time" : "2025-02-28 16:05:21", "owner_name" : "TMSS01", "have_child_dynamic" : false, "has_child" : false, "issue_dynamic_count" : 0, "case_count" : 0 } ] }

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 list Array of SubTaskCaseSuccessLineVo objects 返回结果 page_num Integer 页码 page_size Integer 分页大小 total_page Integer 总页数 total_size Long 总条数 表5 SubTaskCaseSuccessLineVo 参数 参数类型 描述 detail Array of SubTaskCaseSuccessLineDetailVo objects 用例成功率统计信息 task_id String 任务id task_name String 任务名称 表6 SubTaskCaseSuccessLineDetailVo 参数 参数类型 描述 date Long 统计时间 pass_rate Float 成功率 task_id String 任务id task_name String 任务名称 状态码：201 Created 状态码：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 错误原因

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

响应示例 状态码：200 OK { "code" : "success", "data" : [ { "id" : "bf322938390f4fb6a62de5113e80f3cb", "name" : "12313", "project_id" : "0edf40e28ce64bc7936b79896e8ec630", "create_time" : "2024/08/20 10:24:05 GMT+08:00", "creator_name" : "user", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "update_name" : "user", "update_num" : "efdb403066474ab08836b9eeaaa23bca", "update_time" : "2024/08/20 16:39:31 GMT+08:00" } ], "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 Array of Asset objects 返回体 message String 错误信息 表4 Asset 参数 参数类型 描述 id String 参数解释： 因子库ID 取值范围： 大小写字母、数字。 长度限制固定32位 name String 参数解释： 因子库名称。 取值范围： 大小写字母、数字、符号、中文。 project_id String 参数解释： 项目ID 取值范围： 大小写字母、数字。 长度限制固定32位 create_time String 参数解释： 创建时间 creator_name String 参数解释： 创建人名称。 取值范围： 大小写字母、数字、符号、中文。 creator_num String 参数解释： 创建者，用户在IAM中的ID。 取值范围： 大小写字母、数字。 长度限制固定32位 update_name String 参数解释： 更新人名称。 取值范围： 大小写字母、数字、符号、中文。 update_num String 参数解释： 更新人ID 取值范围： 大小写字母、数字。 长度限制固定32位 update_time String 参数解释： 更新时间 状态码：400 表5 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表6 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TestCaseVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表4 TestCaseVo 参数 参数类型 描述 uri String 参数解释 资源URI 取值范围 不涉及 type String 参数解释 资源类型 取值范围 不涉及 author String 参数解释 创建人 取值范围 不涉及 name String 参数解释 名称 取值范围 不涉及 rank Integer 参数解释 级别 取值范围 不涉及 preparation String 参数解释 前置条件 取值范围 不涉及 remark String 参数解释 备注 取值范围 不涉及 stage String 参数解释 测试阶段 取值范围 不涉及 activity String 参数解释 测试类型 取值范围 不涉及 keywords String 参数解释 关键词 取值范围 不涉及 market String 参数解释 apitest标记是否代码已提交 取值范围 不涉及 designer String 参数解释 设计者 取值范围 不涉及 tags String 参数解释 标签 取值范围 不涉及 execute_parameter String 参数解释 执行参数 取值范围 不涉及 region String 参数解释 逻辑region 取值范围 不涉及 owner String 参数解释 处理人id，IteratorTestCase字段 取值范围 不涉及 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 参数解释 编号 取值范围 不涉及 case_type Integer 参数解释 父资源路径 取值范围 不涉及用例类型 platform_type Integer 执行平台类型 service_type Integer 服务类型 service_type_name String 服务类型名称 test_type Integer 测试类型 test_type_name String 测试类型名称 design_note String 设计描述 test_step String 测试步骤 expect_output String 期望结果 env_type String 测试环境类型 exe_platform String 执行平台 testcase_project String 测试工程 svn_script_path String 脚本路径 map_restrict String 约束条件 network_script_name String 网络脚本名 auto_type Integer 自动化类型，非自动化:0, 是自动化:1 to_be_auto_exec Integer 被自动化执行 last_result String 最后一次结果 last_result_uri String 最后一次结果Uri feature_uri String 目录Uri feature_name String 目录名称 interface_name String 测试接口名 snp_no String 网络问题ID dr_relation_id String 关联需求编号 issue_name String 需求名称 test_base_num String 测试基数 automatically_executed Integer 是否被自动化执行 first_execute_time String 第一次执行时间 detect_type String 检测类型 execute_param String 执行参数 test_feature String 分析领域 is_contract_testcase Integer 是否是契约用例，0:表示非契约用例, 1：表示契约用例 time_cost Double 总共耗时 be_auto_type_time String 记录用例由非自动化变为自动化类型的时间 compare_number String 配对用例编号 scene_flag String 场景标识 base_flag String 场景标识 para_validator String 区别是否从yaml中生成的用例，默认false knet_node_id String knet节点id last_exe_author String 最后一次执行用户 cloud_carrier String 运营商 market_place String 应用市场 test_mind_id String 脑图id test_mind_url String 脑图url commit_url String git提交url test_pattern_number String 测试模式编号 test_factor_number String 测试因子编号 status_code String 状态Code result_code String 结果Code release_id String 迭代ID label_id String 标签ID labels String 用例标签名称列表 module_id String 模块ID module_name String 模块名称 module_path String 模块path module_path_name String 模块路径名称 execute_latest_time String 最后执行时间 execute_duration String 执行时长 execute_times Integer 执行次数 is_keyword Integer 是否关键用例 release_dev String 测试版本号 new_created String 是否用户新增用例 project_uuid String 项目ID creation_version_name String 创建版本名称，原逻辑marshall添加字段 feature_path String 特性路径，原逻辑marshall添加字段 testcase_uri String 实体用例Uri，IteratorTestCase字段 owner_name String 处理人名称 iterator_case_uri String 迭代用例Uri，IteratorTestCase字段 script_link String 脚本链接scriptLink test_step_model String 测试步骤模式 text: 文本模式; table: 表格模式 custom_field_1 String 自定义字段1 custom_field_2 String 自定义字段2 custom_field_3 String 自定义字段3 custom_field_4 String 自定义字段4 custom_field_5 String 自定义字段5 custom_field_6 String 自定义字段6 custom_field_7 String 自定义字段7 custom_field_8 String 自定义字段8 custom_field_9 String 自定义字段9 custom_field_10 String 自定义字段10 custom_field_11 String 自定义字段11 custom_field_12 String 自定义字段12 custom_field_13 String 自定义字段13 custom_field_14 String 自定义字段14 custom_field_15 String 自定义字段15 custom_field_16 String 自定义字段16 custom_field_17 String 自定义字段17 custom_field_18 String 自定义字段18 custom_field_19 String 自定义字段19 custom_field_20 String 自定义字段20 custom_field_21 String 自定义字段21 custom_field_22 String 自定义字段22 custom_field_23 String 自定义字段23 custom_field_24 String 自定义字段24 custom_field_25 String 自定义字段25 状态码：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 表3 响应Body参数 参数 参数类型 描述 code String 错误码 error CommonResponseErrorAvailableConfig object 统一错误返回 reason String 失败原因 result AvailableConfig object 结果 status String 状态 表4 CommonResponseErrorAvailableConfig 参数 参数类型 描述 code String 错误码 detail AvailableConfig object 错误信息详情 reason String 错误原因 表5 AvailableConfig 参数 参数类型 描述 custom_aw_available Boolean 自定义关键字是否开通 public_aw_available Boolean 系统关键字是否开通 refresh_aw_available Boolean 一键刷新功能是否开通 状态码：401 Unauthorized 状态码：403 Forbidden 状态码：404 Not Found

响应示例 状态码：200 OK { "status" : "success", "result" : { "public_aw_available" : true, "custom_aw_available" : true, "refresh_aw_available" : true }, "reason" : null, "error" : null, "code" : null }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 参数解释： 错误码 data Template object 返回体 message String 参数解释： 错误信息 表4 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 表5 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表6 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

响应示例 状态码：200 OK { "code" : "success", "data" : { "id" : "19eea79a87854c67a294f06ad48e1e27", "description" : "", "mindmap" : "{\"root\":{\"layout\":\"map\",\"shape\":\"box\",\"id\":\"7a2619bb8ed340b391712c6c855ed02a\",\"text\":\"思维导图\"}}", "name" : "1", "is_default" : null, "create_time" : "2024/08/20 11:08:58 GMT+08:00", "creator_name" : "user", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "update_time" : null }, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

响应示例 状态码：200 OK { "uri" : "v92u00010e58tdun", "type" : "TestCase", "author" : "f3b807a0d249424fa36a0d804110c4ed", "name" : "cccc", "rank" : 2, "stage" : "1", "designer" : "f3b807a0d249424fa36a0d804110c4ed", "region" : "cn-north-7", "last_modifier" : "f3b807a0d249424fa36a0d804110c4ed", "last_modified" : "2025-04-28 15:36:00", "last_modified_timestamp" : 1745825760000, "last_change_time" : "2025-04-28 15:36:00", "version_uri" : "v92s00010db209le", "parent_uri" : "v92s00010db208e5", "parent_path" : "/dc3f9aa646ad4707831080d3fcce474d/v92s00010db208e5/", "creation_date" : "2025-04-28 15:36:00", "creation_date_timestamp" : 1745825760000, "author_name" : "这是高总的昵称", "number" : "101", "case_type" : 0, "platform_type" : 0, "service_type" : 0, "service_type_name" : "手工测试", "test_type" : 1, "test_type_name" : "功能性测试", "test_step" : "[\"\"]", "expect_output" : "[\"\"]", "auto_type" : 0, "to_be_auto_exec" : 0, "feature_name" : "其他", "dr_relation_id" : "1119663863142195200", "automatically_executed" : 0, "is_contract_testcase" : 0, "time_cost" : 0, "status_code" : "0", "labels" : [ ], "execute_times" : 0, "is_keyword" : 0, "project_uuid" : "dc3f9aa646ad4707831080d3fcce474d", "testcase_uri" : "v92u00010e58tdun", "issue_name" : "开发汽车产品及服务在线销售网站和移动端商城", "remark" : "xx", "release_dev" : "" }

请求示例 put https://{endpoint}/GT3KServer/v4/testcases/v92u00010e58tdun { "author": "f3b807a0d249424fa36a0d804110c4ed", "name": "cccc", "rank": 2, "stage": "1", "designer": "f3b807a0d249424fa36a0d804110c4ed", "region": "cn-north-7", "version_uri": "v92s00010db209le", "number": "101", "case_type": 0, "platform_type": 0, "service_type": 0, "test_type": 1, "test_step": "[\"\"]","expect_output":"[\"\"]", "auto_type": 0, "to_be_auto_exec": 0, "dr_relation_id": "1119663863142195200", "automatically_executed": 0, "is_contract_testcase": 0, "time_cost": 0, "status_code": "0", "is_keyword": 0, "project_uuid": "dc3f9aa646ad4707831080d3fcce474d", "steps": [{ "test_step": "", "expect_result": "" }], "remark": "xx", "label_names": [], "release_dev": "", }

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 uri String 参数解释 资源URI 取值范围 不涉及 type String 参数解释 资源类型 取值范围 不涉及 author String 参数解释 创建人 取值范围 不涉及 name String 参数解释 名称 取值范围 不涉及 rank Integer 参数解释 级别 取值范围 不涉及 preparation String 参数解释 前置条件 取值范围 不涉及 remark String 参数解释 备注 取值范围 不涉及 stage String 参数解释 测试阶段 取值范围 不涉及 activity String 参数解释 测试类型 取值范围 不涉及 keywords String 参数解释 关键词 取值范围 不涉及 market String 参数解释 apitest标记是否代码已提交 取值范围 不涉及 designer String 参数解释 设计者 取值范围 不涉及 tags String 参数解释 标签 取值范围 不涉及 execute_parameter String 参数解释 执行参数 取值范围 不涉及 region String 参数解释 逻辑region 取值范围 不涉及 owner String 参数解释 处理人id，IteratorTestCase字段 取值范围 不涉及 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 参数解释 编号 取值范围 不涉及 case_type Integer 参数解释 父资源路径 取值范围 不涉及用例类型 platform_type Integer 执行平台类型 service_type Integer 服务类型 service_type_name String 服务类型名称 test_type Integer 测试类型 test_type_name String 测试类型名称 design_note String 设计描述 test_step String 测试步骤 expect_output String 期望结果 env_type String 测试环境类型 exe_platform String 执行平台 testcase_project String 测试工程 svn_script_path String 脚本路径 map_restrict String 约束条件 network_script_name String 网络脚本名 auto_type Integer 自动化类型，非自动化:0, 是自动化:1 to_be_auto_exec Integer 被自动化执行 last_result String 最后一次结果 last_result_uri String 最后一次结果Uri feature_uri String 目录Uri feature_name String 目录名称 interface_name String 测试接口名 snp_no String 网络问题ID dr_relation_id String 关联需求编号 issue_name String 需求名称 test_base_num String 测试基数 automatically_executed Integer 是否被自动化执行 first_execute_time String 第一次执行时间 detect_type String 检测类型 execute_param String 执行参数 test_feature String 分析领域 is_contract_testcase Integer 是否是契约用例，0:表示非契约用例, 1：表示契约用例 time_cost Double 总共耗时 be_auto_type_time String 记录用例由非自动化变为自动化类型的时间 compare_number String 配对用例编号 scene_flag String 场景标识 base_flag String 场景标识 para_validator String 区别是否从yaml中生成的用例，默认false knet_node_id String knet节点id last_exe_author String 最后一次执行用户 cloud_carrier String 运营商 market_place String 应用市场 test_mind_id String 脑图id test_mind_url String 脑图url commit_url String git提交url test_pattern_number String 测试模式编号 test_factor_number String 测试因子编号 status_code String 状态Code result_code String 结果Code release_id String 迭代ID label_id String 标签ID labels String 用例标签名称列表 module_id String 模块ID module_name String 模块名称 module_path String 模块path module_path_name String 模块路径名称 execute_latest_time String 最后执行时间 execute_duration String 执行时长 execute_times Integer 执行次数 is_keyword Integer 是否关键用例 release_dev String 测试版本号 new_created String 是否用户新增用例 project_uuid String 项目ID creation_version_name String 创建版本名称，原逻辑marshall添加字段 feature_path String 特性路径，原逻辑marshall添加字段 testcase_uri String 实体用例Uri，IteratorTestCase字段 owner_name String 处理人名称 iterator_case_uri String 迭代用例Uri，IteratorTestCase字段 script_link String 脚本链接scriptLink test_step_model String 测试步骤模式 text: 文本模式; table: 表格模式 custom_field_1 String 自定义字段1 custom_field_2 String 自定义字段2 custom_field_3 String 自定义字段3 custom_field_4 String 自定义字段4 custom_field_5 String 自定义字段5 custom_field_6 String 自定义字段6 custom_field_7 String 自定义字段7 custom_field_8 String 自定义字段8 custom_field_9 String 自定义字段9 custom_field_10 String 自定义字段10 custom_field_11 String 自定义字段11 custom_field_12 String 自定义字段12 custom_field_13 String 自定义字段13 custom_field_14 String 自定义字段14 custom_field_15 String 自定义字段15 custom_field_16 String 自定义字段16 custom_field_17 String 自定义字段17 custom_field_18 String 自定义字段18 custom_field_19 String 自定义字段19 custom_field_20 String 自定义字段20 custom_field_21 String 自定义字段21 custom_field_22 String 自定义字段22 custom_field_23 String 自定义字段23 custom_field_24 String 自定义字段24 custom_field_25 String 自定义字段25 状态码：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参数 参数 是否必选 参数类型 描述 steps 否 Array of TestCaseStepInfo objects 参数解释: 测试步骤 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及 attachments 否 Array of TestCaseAttachmentInfo objects 参数解释: 附件 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及 author 否 String 参数解释 创建人 约束限制 1-32个英文或者数字 取值范围 不涉及 默认取值 不涉及 name 是 String 参数解释 名称 约束限制 长度限制128字符 取值范围 不涉及 默认取值 不涉及 rank 否 Integer 参数解释 用例等级 约束限制 不涉及 取值范围 取值范围：0,1,2,3,4 默认取值 不涉及 owner 否 String 参数解释 处理人 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 preparation 否 String 参数解释 前置条件 约束限制 长度限制3000字符 取值范围 不涉及 默认取值 不涉及 remark 否 String 参数解释 备注 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 stage 否 String 参数解释 测试阶段 约束限制 长度限制50字符 取值范围 不涉及 默认取值 不涉及 activity 否 String 参数解释 测试类型 约束限制 长度限制64字符 取值范围 不涉及 默认取值 不涉及 keywords 否 String 参数解释 关键词 约束限制 长度限制512字符 取值范围 不涉及 默认取值 不涉及 market 否 String 参数解释 apitest标记是否代码已提交 约束限制 长度限制1024字符 取值范围 不涉及 默认取值 不涉及 designer 否 String 参数解释 设计者 约束限制 长度限制64字符 取值范围 不涉及 默认取值 不涉及 tags 否 String 参数解释 标签 约束限制 长度限制512字符 取值范围 不涉及 默认取值 不涉及 region 否 String 参数解释 逻辑region，外部使用公有云实际区域，内部使用默认值 约束限制 长度限制32字符 取值范围 不涉及 默认取值 不涉及 relate_type 否 String 参数解释 关联资源类型 约束限制 不涉及 取值范围 取值范围：requirement|bug 默认取值 不涉及 service_type 否 Integer 参数解释 服务类型 约束限制 1到7位数字 取值范围 不涉及 默认取值 不涉及 only_change_script 否 String 参数解释 更新接口用例的java脚本路径标识 约束限制 长度限制32字符 取值范围 不涉及 默认取值 不涉及 add_to_iterator 否 String 参数解释 需求添加到迭代标识 约束限制 长度限制5字符 取值范围 不涉及 默认取值 不涉及 need_update_relation 否 String 参数解释 是否修改关联关系 约束限制 长度限制5字符 取值范围 不涉及 默认取值 不涉及 creation_version_uri 否 String 参数解释 创建版本Uri 约束限制 11到34位英文或数字 取值范围 不涉及 默认取值 不涉及 number 否 String 参数解释 用例编号 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 case_type 否 Integer 参数解释 用例类型 约束限制 不涉及 取值范围 取值范围：-128-127 默认取值 不涉及 platform_type 否 Integer 参数解释 执行平台类型 约束限制 不涉及 取值范围 取值范围：-128-127 默认取值 不涉及 test_type 否 Integer 参数解释 测试类型 约束限制 不涉及 取值范围 取值范围：-128-127 默认取值 不涉及 design_note 否 String 参数解释 设计描述 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 test_step 否 String 参数解释 测试步骤 约束限制 长度限制250000字符 取值范围 不涉及 默认取值 不涉及 expect_output 否 String 参数解释 期望结果 约束限制 长度限制250000字符 取值范围 不涉及 默认取值 不涉及 env_type 否 String 参数解释 测试环境类型 约束限制 长度限制512字符 取值范围 不涉及 默认取值 不涉及 exe_platform 否 String 参数解释 执行平台 约束限制 长度限制200字符 取值范围 不涉及 默认取值 不涉及 testcase_project 否 String 参数解释 测试工程 约束限制 长度限制1024字符 取值范围 不涉及 默认取值 不涉及 svn_script_path 否 String 参数解释 脚本路径 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 map_restrict 否 String 参数解释 约束条件 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 network_script_name 否 String 参数解释 网络脚本名 约束限制 长度限制500字符 取值范围 不涉及 默认取值 不涉及 auto_type 否 Integer 参数解释 自动化类型，非自动化:0, 是自动化:1 约束限制 长度限制500字符 取值范围 取值范围：0,1 默认取值 不涉及 to_be_auto_exec 否 Integer 参数解释 被自动化执行 约束限制 不涉及 取值范围 -128-127 默认取值 不涉及 last_result 否 String 参数解释 最后一次结果 约束限制 长度限制16字符 取值范围 不涉及 默认取值 不涉及 last_result_uri 否 String 参数解释 最后一次结果Uri 约束限制 不涉及 取值范围 11-34位数字或英文 默认取值 不涉及 feature_uri 否 String 参数解释 目录Uri 约束限制 不涉及 取值范围 11-34位数字或英文 默认取值 不涉及 interface_name 否 String 参数解释 测试接口名 约束限制 长度限制200字符 取值范围 不涉及 默认取值 不涉及 snp_no 否 String 参数解释 网络问题ID 约束限制 长度限制500字符 取值范围 不涉及 默认取值 不涉及 dr_relation_id 否 String 参数解释 关联需求编号 约束限制 不涉及 取值范围 1-32位数字 默认取值 不涉及 test_base_num 否 String 参数解释 测试基数 约束限制 长度限制200字符 取值范围 不涉及 默认取值 不涉及 automatically_executed 否 Integer 参数解释 是否被自动化执行 约束限制 不涉及 取值范围 -128-127 默认取值 不涉及 first_execute_time 否 String 参数解释 第一次执行时间 约束限制 d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} 取值范围 不涉及 默认取值 不涉及 detect_type 否 String 参数解释 检测类型 约束限制 长度限制100字符 取值范围 不涉及 默认取值 不涉及 execute_param 否 String 参数解释 执行参数 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 test_feature 否 String 参数解释 分析领域 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 is_contract_testcase 否 Integer 参数解释 是否是契约用例，0:表示非契约用例, 1：表示契约用例 约束限制 不涉及 取值范围 0,1 默认取值 不涉及 time_cost 否 Double 参数解释 总共耗时 约束限制 不涉及 取值范围 2147483648.44-2147483647.44 默认取值 不涉及 custom_field_1 否 String 参数解释 自定义字段1 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_2 否 String 参数解释 自定义字段2 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_3 否 String 参数解释 自定义字段3 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_4 否 String 参数解释 自定义字段4 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_5 否 String 参数解释 自定义字段5 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_6 否 String 参数解释 自定义字段6 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_7 否 String 参数解释 自定义字段7 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_8 否 String 参数解释 自定义字段8 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_9 否 String 参数解释 自定义字段9 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_10 否 String 参数解释 自定义字段10 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_11 否 String 参数解释 自定义字段11 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_12 否 String 参数解释 自定义字段12 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_13 否 String 参数解释 自定义字段13 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_14 否 String 参数解释 自定义字段14 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_15 否 String 参数解释 自定义字段15 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_16 否 String 参数解释 自定义字段16 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_17 否 String 参数解释 自定义字段17 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_18 否 String 参数解释 自定义字段18 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_19 否 String 参数解释 自定义字段19 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_20 否 String 参数解释 自定义字段20 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_21 否 String 参数解释 自定义字段21 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_22 否 String 参数解释 自定义字段22 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_23 否 String 参数解释 自定义字段23 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_24 否 String 参数解释 自定义字段24 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 custom_field_25 否 String 参数解释 自定义字段25 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 be_auto_type_time 否 String 参数解释 记录用例由非自动化变为自动化类型的时间 约束限制 d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} 取值范围 不涉及 默认取值 不涉及 compare_number 否 String 参数解释 配对用例编号 约束限制 长度限制100字符 取值范围 不涉及 默认取值 不涉及 scene_flag 否 String 参数解释 场景标识 约束限制 长度限制50字符 取值范围 不涉及 默认取值 不涉及 base_flag 否 String 参数解释 场景标识 约束限制 长度限制50字符 取值范围 不涉及 默认取值 不涉及 para_validator 否 String 参数解释 区别是否从yaml中生成的用例，默认false 约束限制 长度限制50字符 取值范围 不涉及 默认取值 false knet_node_id 否 String 参数解释 knet节点id 约束限制 长度限制50字符 取值范围 不涉及 默认取值 不涉及 last_exe_author 否 String 参数解释 最后一次执行用户 约束限制 长度限制50字符 取值范围 不涉及 默认取值 不涉及 cloud_carrier 否 String 参数解释 运营商 约束限制 长度限制100字符 取值范围 不涉及 默认取值 不涉及 market_place 否 String 参数解释 应用市场 约束限制 长度限制1024字符 取值范围 不涉及 默认取值 不涉及 test_mind_id 否 String 参数解释 脑图id 约束限制 长度限制256字符 取值范围 不涉及 默认取值 不涉及 test_mind_url 否 String 参数解释 脑图url 约束限制 长度限制1024字符 取值范围 不涉及 默认取值 不涉及 commit_url 否 String 参数解释 git提交url 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 test_pattern_number 否 String 参数解释 测试模式编号 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 test_factor_number 否 String 参数解释 测试因子编号 约束限制 长度限制65535字符 取值范围 不涉及 默认取值 不涉及 status_code 否 String 参数解释 状态Code 约束限制 [-]?[0-9]{1,5} 取值范围 不涉及 默认取值 不涉及 result_code 否 String 参数解释 测试因子编号 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 release_id 否 String 参数解释 迭代ID 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 label_id 否 String 参数解释 标签ID 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 label_names 否 Array of strings 参数解释 用例操作时，标签名列表 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 module_id 否 String 参数解释 模块ID 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 execute_latest_time 否 String 参数解释 最后执行时间 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 execute_duration 否 String 参数解释 执行时长 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 is_keyword 否 Integer 参数解释 是否关键用例 约束限制 不涉及 取值范围 -128-127 默认取值 不涉及 release_dev 否 String 参数解释 测试版本号 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 new_created 否 Integer 参数解释 是否用户新增用例 约束限制 不涉及 取值范围 -128-127 默认取值 不涉及 execute_parameter 否 String 参数解释 执行参数 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 project_uuid 否 String 参数解释 项目ID，外部使用项目ID，内部使用默认值 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 version_uri 否 String 参数解释 分支或者迭代uri 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 表4 TestCaseStepInfo 参数 是否必选 参数类型 描述 test_step 否 String 参数解释 测试步骤 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 expect_result 否 String 参数解释 预期结果 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 step_actual 否 String 参数解释 步骤的实际结果 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 step_result 否 String 参数解释 步骤结果 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 表5 TestCaseAttachmentInfo 参数 是否必选 参数类型 描述 override 否 Boolean 参数解释 附件是否要被覆盖 约束限制 不涉及 取值范围 true|false 默认取值 不涉及 doc_id 否 String 参数解释 文档id 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 file_name 否 String 参数解释 文件名 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 file_path 否 String 参数解释 文件路径 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 file_type 否 String 参数解释 文件类型 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 file_size 否 String 参数解释 文件大小 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 override_id 否 String 参数解释 重复用例ID 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 related_type 否 String 参数解释 相关类型 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 store_file_name 否 String 参数解释 保存文件名 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 system_type 否 String 参数解释 系统区分 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 storage_system 否 String 参数解释 区分文件存储系统 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及

响应示例 状态码：200 OK { "status" : "ok", "result" : { "000000" : [ { "id" : "41815b0aca2f4a059caea559aa687825", "createUser" : "efdb403066474ab00000", "createTime" : 1734319161000, "updateUser" : "efdb403066474ab00000", "updateTime" : 1737091129000, "userName" : "XXXX", "testServiceId" : "1234567abc", "userType" : "1", "nickName" : "XXXX", "domainId" : "123456789", "domainName" : "XXX", "userId" : "123456", "roleId" : "12,34", "roleName" : "项目经理,项目管理员", "projectUser" : true, "realUsesName" : "XXX" } ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 否 String 告警组ID group_ids 否 Array of strings 告警组ID列表 page_num 否 Integer 当前页数 page_size 否 Integer 每页大小 test_service_id 否 String 服务ID user_ids 否 Array of strings 用户ID列表 user_name 否 String 用户名

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 参数解释 接口返回状态，ok-成功，failed-失败 约束限制 不涉及 取值范围 ok,failed 默认取值 ok result Object 参数解释 告警组查询结果 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 表5 AlertUserDto 参数 参数类型 描述 alert_channel String 告警通道，{"email":"1"," SMS ":"1"}， 0=关闭，1=开通 create_time String 创建时间 create_user String 创建者 domain_id String 所属租户Id domain_name String 所属租户名称 email_address String 邮箱 group_id String 告警组ID id String UUID nick_name String 用户昵称 phone_number String 电话号码 project_user Boolean 是否是项目成员 remarks String 备注 role_id String 角色id role_name String 角色名称 test_service_id String 服务ID update_time String 修改时间 update_user String 修改者 user_id String 用户Id user_name String 告警用户名 user_num String 用户编号 user_type String 用户类型 welink_no String welink/espace账号 状态码：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 错误原因

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 返回状态码，OK表示接口调用成功 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因

URI GET /v4/projects/{service_id}/tasks/name 表1 路径参数 参数 是否必选 参数类型 描述 service_id 是 String 参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 task_name 是 String 任务名 task_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" : { "updater_num_list" : { "e8ad9e7478c94f4eaf90d5a379af9cb1" : "lwx1开发人员21" }, "updater_name_list" : { "devcloud_testman_01" : "lwx1开发人员21" }, "creator_num_list" : { "e8ad9e7478c94f4eaf90d5a379af9cb1" : "lwx1开发人员21" }, "creator_name_list" : { "devcloud_testman_01" : "lwx1开发人员21" } }, "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" : "认证信息过期" }

响应参数 状态码：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 参数解释： 接口调用错误信息