华为云用户手册

响应参数 状态码： 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 任务名称 状态码： 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 错误原因

响应参数 状态码： 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 接口调用错误信息 状态码： 404 表6 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 500 表7 响应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 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 业务失败的提示内容

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 value Array of ProjectTestCaseFieldVo objects 本次查询的记录结果 表4 ProjectTestCaseFieldVo 参数 参数类型 描述 uri String 项目用例自定义字段主键 name String 项目用例自定义字段名称 type String 项目用例自定义字段类型（单行文本text、多行文本textArea、单选框radio、多选框checkBox、日期date、数字number、单选用户user） options String 项目用例自定义字段选项（数字类型时，数组两个值，第一个是最小值，第二个是最大值） description String 项目用例自定义字段描述 creator String 项目用例自定义字段创建人 updater String 项目用例自定义字段更新人 custom_field_id Integer 项目用例自定义字段id（1-25数字） custom_field_name String 项目用例自定义字段名称 custom_field_param String 项目用例自定义字段入参或者返回参数名称 type_name String 项目用例自定义字段类型国际化名称 create_time String 项目用例自定义字段创建时间 create_time_timestamp Long 项目用例自定义字段创建时间时间戳 update_time String 项目用例自定义字段更新时间 update_time_timestamp Long 项目用例自定义字段更新时间时间戳 project_uuid String 项目id 状态码： 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 { "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 错误码 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 一键刷新功能是否开通

响应参数 状态码： 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 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的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 steps 否 Array of TestCaseStepInfo objects 测试步骤 attachments 否 Array of TestCaseAttachmentInfo objects 附件 author 否 String 创建人 name 是 String 名称 rank 否 Integer 用例等级 owner 否 String 处理人 preparation 否 String 前置条件 remark 否 String 备注 stage 否 String 测试阶段 activity 否 String 测试类型 keywords 否 String 关键词 market 否 String apitest标记是否代码已提交 designer 否 String 设计者 tags 否 String 标签 region 否 String 逻辑region，外部使用公有云实际区域，内部使用默认值 relate_type 否 String 关联资源类型 service_type 否 Integer 服务类型 only_change_script 否 String 更新接口用例的java脚本路径标识 add_to_iterator 否 String 需求添加到迭代标识 need_update_relation 否 String 是否修改关联关系 creation_version_uri 否 String 创建版本Uri number 否 String 用例编号 case_type 否 Integer 用例类型 platform_type 否 Integer 执行平台类型 test_type 否 Integer 测试类型 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 interface_name 否 String 测试接口名 snp_no 否 String 网络问题ID dr_relation_id 否 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 总共耗时 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 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 label_names 否 Array of strings 用例操作时，标签名列表 module_id 否 String 模块ID execute_latest_time 否 String 最后执行时间 execute_duration 否 String 执行时长 is_keyword 否 Integer 是否关键用例 release_dev 否 String 测试版本号 new_created 否 Integer 是否用户新增用例 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 附件是否要被覆盖 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 表4 响应Body参数 参数 参数类型 描述 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，商用版与projectMan的identifier字段相同，内部版与id相同 user_name String 告警用户名 user_num String 用户编号 user_type String 用户类型，1=内部用户；2=外部用户 welink_no String welink/espace账号 状态码： 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 错误原因

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String token 表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参数 参数 参数类型 描述 service_id Integer 接口调用成功返回的服务id service_name String 接口调用成功返回的服务名 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 主账号用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 server_host 是 String 参数解释: server_host是由用户提供的 域名 。我们会通过此域名进行接口调用，测试计划将会通过此域名下的接口，保证服务数据与用户系统数据的一致性。 约束限制: 不涉及 取值范围: 以https/http开头 长度小于等于128位字符。 默认取值: 不涉及 service_name 是 String 参数解释: 测试类型名称，用于界面显示，不能使用当前已有测试类型名称，长度小于等于128。 约束限制: 不涉及 取值范围: 长度小于等于128。 默认取值: 不涉及

响应示例 状态码： 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 }

响应参数 状态码： 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 接口调用错误信息 状态码： 404 表6 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码： 500 表7 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 end_row Long 当前页面最后一个元素在数据库中的行号 has_next_page Boolean 是否有下一页 has_previous_page Boolean 是否有前一页 is_first_page Boolean 是否为第一页 is_last_page Boolean 是否为最后一页 list Array of SubtaskcaseOverstockDto objects 返回结果 navigate_first_page Integer 导航条上的第一页 navigate_last_page Integer 导航条上的最后一页 navigate_pages Integer 导航页码数 navigatepage_nums Array of integers 所有导航页号 next_page Integer 下一页 page_num Integer 当前页 page_size Integer 每页的数量 pages Integer 总页数 pre_page Integer 前一页 size Integer 当前页的数量 start_row Long 当前页面第一个元素在数据库中的行号 total Long 总条数 表5 SubtaskcaseOverstockDto 参数 参数类型 描述 data_time String 查询时间 executor_type String 执行机类型 id String UUID label String 执行机标签 location_id String 执行机所属区域 subtaskcase_overstock_count Integer 积压数量 test_service_id String 服务ID 状态码： 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 错误原因

URI GET /v1/projects/{service_id}/dashboard/statistic/block 表1 路径参数 参数 是否必选 参数类型 描述 service_id 是 String 服务id 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 数据开始时间 end_time 是 Long 数据结束时间 executor_type 否 String 执行机类型 label 是 String 执行机标签 location_id 否 String 执行机所属区域id page_num 否 Integer 分页当前页码 page_size 否 Integer 分页大小(分页参数只要有一个为空即不做分页)

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 是否请求成功 result popUpInfo object 计费信息 error CommonResponseErrorOfAPITest object 错误详情 表4 popUpInfo 参数 参数类型 描述 popup Boolean 是否弹窗 time_limit Object 包周期计费时长上限 表5 CommonResponseErrorOfAPITest 参数 参数类型 描述 code String 错误码 reason String 错误原因

响应示例 状态码： 200 OK { "assigned_user" : { "id" : "ID", "name" : "名称" }, "execute_count" : 4, "extend_info" : { "author" : { "id" : "1111", "name" : "名称", "time" : "2000-01-01 00:00:00" }, "defect_list" : [ { "id" : "ID", "name" : "名称" } ], "description" : "描述信息", "domain" : { "id" : "ID", "name" : "名称" }, "fixed_version" : { "id" : "ID", "name" : "名称" }, "issue" : { "id" : "ID", "name" : "名称" }, "label_list" : [ { "id" : "ID", "name" : "名称" } ], "module" : { "id" : "ID", "name" : "名称" }, "preparation" : "前置条件", "steps" : [ { "expect_result" : "[\"\\u003cp\\u003e预期结果1\\u003c/p\\u003e\",\"\\u003cp\\u003e预期结果2\\u003c/p\\u003e\"]", "test_step" : "[\"\\u003cp\\u003e步骤描述1\\u003c/p\\u003e\",\"\\u003cp\\u003e步骤描述2\\u003c/p\\u003e\"]" } ], "test_version_id" : "97b82412f1", "updator" : { "id" : "1111", "name" : "名称", "time" : "2000-01-01 00:00:00" } }, "name" : "某个测试用例", "project_id" : "2394921", "rank_id" : "2", "result_id" : "0", "service_id" : 13, "status_id" : "1", "testcase_id" : "97b82412f1ca4628803b918c27ed09de", "testcase_number" : "1234" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 assigned_user AssignedUserInfo object 处理者信息 execute_count Integer 测试用例执行次数 extend_info ExtendInfo object 测试用例扩展信息 name String 测试用例名称 project_id String 软开云项目唯一标识 rank_id String 测试用例等级 result_id String 测试用例执行结果 service_id Integer 注册测试类型服务接口返回的服务id status_id String 测试用例状态 testcase_id String 用例uri,测试用例唯一标识,长度11-34位字符（字母和数字）。 testcase_number String 测试用例编号 表5 ExtendInfo 参数 参数类型 描述 author ExtendAuthorInfo object 创建者信息 defect_list Array of AssignedUserInfo objects 缺陷信息 description String 描述信息 domain AssignedUserInfo object 租户信息 fixed_version AssignedUserInfo object 迭代信息 issue AssignedUserInfo object 需求信息 label_list Array of AssignedUserInfo objects 标签信息 module AssignedUserInfo object 模块信息 preparation String 前置条件 steps Array of ExternalServiceCaseStep objects 测试步骤，数组长度小于10 test_version_id String 测试版本号 updator ExtendAuthorInfo object 更新者信息 表6 AssignedUserInfo 参数 参数类型 描述 id String id信息 name String 名称信息 表7 ExternalServiceCaseStep 参数 参数类型 描述 expect_result String 测试用例预期结果信息，长度为[0-500]位字符 test_step String 测试步骤描述信息，长度为[0-500]位字符 表8 ExtendAuthorInfo 参数 参数类型 描述 id String id信息 name String 名称信息 time String 时间信息 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

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

请求示例 新增测试套任务 post https://{endpoint}/v4/300c6295a54c4c698608c878f47ddd59/tasks { "name" : "testsuite01", "service_type" : 0, "number" : "", "description" : "", "case_operation_info" : { "set_up_cases_info" : [ ], "tear_down_cases_info" : [ ], "test_cases_info" : [ ] }, "tags" : [ ], "module_id" : "", "module_name" : "", "execute_way" : 1, "ext_param" : "{}", "release_dev" : "", "version_uri" : "v91j0000vldleodb", "plan_start_timestamp" : null, "plan_end_timestamp" : null }

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueString object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表8 ResultValueString 参数 参数类型 描述 value String testbird key 表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 接口调用失败错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表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

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

请求示例 项目下创建计划 post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/plans { "assigned_id" : "efdb403066474ab08836b9eeaaa23bca", "name" : "这是一个测试计划名称", "plan_cycle" : { "end_date" : "2020-03-31", "start_date" : "2020-03-04" }, "service_id_list" : [ 13, 24 ] }

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 plan_id String 接口调用成功返回的计划id error_code String 接口调用成功不返回，调用失败错误码 error_msg String 接口调用成功不返回，调用失败错误信息 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 assigned_id 否 String 处理者id，不填时默认使用当前用户 name 是 String 计划名称 plan_cycle 是 PlanCycle object 计划周期 service_id_list 是 Array of integers 计划下包含的用例类型，数组长度小于10个 表4 PlanCycle 参数 是否必选 参数类型 描述 end_date 是 String 计划结束时间，要求用UTC时间表示。如2020-03-31 start_date 是 String 计划开始时间，要求用UTC时间表示。如2020-03-04

响应示例 状态码： 200 OK { "status" : "success", "result" : { "value" : { "uri" : "v9200000vrnjebem", "description" : "", "creator" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "updator" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "task_uri" : "v91i0000vq98sv3v", "version_uri" : "v91i0000vq98suq1", "create_time" : "2024-09-10 20:37:44", "update_time" : "2024-09-10 20:37:44", "start_time" : "2024-09-10 20:37:44", "end_time" : "2024-09-10 20:37:44", "result_code" : 0, "finish_flg" : 1, "project_uuid" : "30649eb093c2479d92c74c75d36ef280" } } }

请求示例 设置测试套结果 post https://{endpoint}/v4/30649eb093c2479d92c74c75d36ef280/tasks/v91i0000vq98sv3v/results { "result_code" : "0", "description" : "", "test_result_uri" : "v9200000vrnjebem", "release_dev" : null }