华为云用户手册

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" : { "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 }

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueTaskResultVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueTaskResultVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value TaskResultVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 TaskResultVo 参数 参数类型 描述 uri String URI name String 测试套名称 description String 描述 owner String 责任人 creator String 创建人id updator String 更新人 task_uri String 任务uri owner_name String 责任人名称 release_dev String 发布版本号 version_uri String 分支/迭代uri creator_name String 创建人名称 create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 updator_name String 更新人名称 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 start_time String 开始时间 start_time_timestamp Long 开始时间时间戳 end_time String 结束时间 end_time_timestamp Long 开始时间时间戳 result_code Integer 执行结果Code result_name String 测试结果名称 finish_flg Integer 测试任务是否执行完成（0：未完成，1：已完成） project_uuid 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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 描述 release_dev 否 String 发布版本号 result_code 否 String 结果Code test_result_uri 否 String 任务执行结果Uri status_code 否 String 状态Code version_uri 否 String 分支/迭代uri

请求示例 { "start_index" : 1, "end_index" : 2, "key_word" : "", "sort_field" : "", "sort_type" : "", "test_case_uris" : [ ], "is_async" : true, "feature_uri" : "907d6252400e4dafb33f489ba1510a1b" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 owners 否 Array of strings 处理者 authors 否 Array of strings 创建者 ranks 否 Array of strings 用例等级 test_case_uris 否 Array of strings 用例Uris service_type 否 Integer 服务类型 task_uri 否 String 任务/测试套Uri feature_uri 否 String 目录Uri key_word 否 String 关键字 sort_field 否 String 排序字段 sort_type 否 String 升序/降序 start_index 否 String 起始位置 end_index 否 String 结束位置 start_time 否 String 创建日期范围起始时间 end_time 否 String 创建日期范围结束时间 last_exe_authors 否 Array of strings 最后一次执行用户 module_ids 否 Array of strings 模块id release_ids 否 Array of strings 迭代id status_codes 否 Array of strings 用例状态 result_codes 否 Array of strings 执行结果Code issue_id 否 String 需求id execute_start_time 否 String 最近执行时间范围起始时间 execute_end_time 否 String 最近执行时间范围结束时间 label_ids 否 Array of strings 标签Id include_sub_issue 否 Boolean 是否查询子需求关联的用例，默认true include_sub_feature 否 Boolean 是否查询子目录的用例，默认true case_type 否 Integer 用例类型 associated_issue 否 Boolean 是否关联需求（null：不限，false：未关联，true：已关联） associated_defects 否 Boolean 是否关联缺陷（null：不限，false：未关联，true：已关联） is_keyword 否 Boolean 是否组合关键字 issue_tree_search 否 Boolean 是否是需求树点击的查询关联用例 service_types 否 Array of integers 服务类型集合 stage_type 否 Integer 阶段过程（2：测试设计，3：测试执行，4：质量报告） custom_field_info 否 Array of QueryCustomFieldsInfo objects 用例自定义字段信息 is_async 否 Boolean 是否异步执行 test_designs 否 Array of booleans 是否来自测试设计（null或者[true, false]：不限，[true]：来自测试设计，[false]：否来自测试设计） not_assign_task 否 Boolean 该字段为false,则查询全量用例，为true表示查询未分配测试套的用例 test_types 否 Array of strings 类型 review_status 否 Integer 用例评审状态 表3 QueryCustomFieldsInfo 参数 是否必选 参数类型 描述 id 否 Integer 参数解释: 测试用例自定义字段Id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 values 否 Array of strings 参数解释: 测试用例自定义字段值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 field_name 否 String 参数解释: 自定义字段名 约束限制: 不涉及 取值范围: 优先取id再取fieldName 默认取值: 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 参数解释: 本次请求的处理状态 取值范围: success|error result ResultValueString object 参数解释: 请求结果 取值范围: 非必返 error ApiError object 参数解释: 错误信息 取值范围: 非必返 request_id String 参数解释: 请求的唯一id 取值范围: 非必返 address String 参数解释: 本次请求的受理的服务地址。 取值范围: 非必返 表5 ResultValueString 参数 参数类型 描述 value String 参数解释 resultObject 取值范围 不涉及 表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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 value Boolean 实际的数据类型：单个对象，集合 或 NULL 状态码：400 表3 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表4 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表5 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表6 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

响应参数 状态码：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参数 参数 是否必选 参数类型 描述 project_uuid 否 String 项目id iterator_uri 否 String 迭代uri type 否 Integer 资源类型, 对应serviceType is_all_issues 否 String 是否选择issues all_import 否 Boolean 是否选择所有用例 feature_uri 否 String 按照目录引入用例 simple_resourceinfo_list 否 Array of SimpleResourceInfo objects 选择的资源列表, 对应sourceCaseUris invert_simple_resourceinfo_list 否 Array of SimpleResourceInfo objects 反选的资源列表 add_to_iterator 否 Boolean 是否将需求添加到测试计划（不传或者true添加需求到测试计划，false就不添加） 表4 SimpleResourceInfo 参数 是否必选 参数类型 描述 type 否 String 资源类型 owner 否 String 资源责任人 resource_id 否 String 资源id

请求示例 post https://{endpoint}/GT3KServer/v4/iterators/v92s00010db209le/testcases/batch-add? { "project_uuid" : "dc3f9aa646ad4707831080d3fcce474d", "is_all_issues" : 0, "invert_simple_resourceinfo_list" : [ ], "simple_resourceinfo_list" : [ { "resource_id" : "v92s00010db20aij" }, { "resource_id" : "v92s00010db20aiq" }, { "resource_id" : "v92s00010db20aj1" }, { "resource_id" : "v92s00010db20aj6" }, { "resource_id" : "v92s00010db20ajc" }, { "resource_id" : "v92s00010db20aji" }, { "resource_id" : "v92u00010e58tdun" } ], "type" : -1, "add_to_iterator" : false }

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : { "uri" : "v91j0000vldlep5u", "name" : "样例功能套件", "number" : "002", "region" : "cn-north-7", "author_id" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "author_name" : "xxx", "owner_id" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "owner_name" : "xxx", "parent_path" : "/300c6295a54c4c698608c878f47ddd59/v91j0000vldleo9v/", "version_uri" : "v91j0000vldleo9v", "branch_uri" : "v91j0000vldleo9v", "creation_date" : "2024-06-24 10:26:19", "create_date_timestamp" : 1719195979000, "update_time" : "2024-06-24 10:26:19", "update_time_timestamp" : 1719195979000, "relation_change_time" : "2024-06-24 10:26:19", "relation_change_time_timestamp" : 1719195979000, "updator_id" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "relation_changer_id" : "e8d27b5521a64fb28a8fd9c99cd66eb3", "service_type" : 0, "tag_list" : [ ], "execute_way" : 1, "execute_type" : 0, "status_code" : 0, "execute_status_code" : 0, "project_uuid" : "300c6295a54c4c698608c878f47ddd59", "case_operation_info" : { "test_cases_info" : [ { "case_uri" : "v91j0000vldlep4q", "sort" : 1, "is_available" : 1, "test_case_name" : "样例功能用例_修改", "test_case_number" : "008" } ], "set_up_cases_info" : [ ], "tear_down_cases_info" : [ ] }, "assign_case_num" : 0, "finish_case_num" : 0, "assign_defect_num" : 0, "iterator_version_uri" : "v91j0000vldleodb" } } }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueTaskVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueTaskVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value TaskVo object 测试任务集合 reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 TaskVo 参数 参数类型 描述 uri String 测试任务URI name String 测试任务名称 stage String 测试阶段 number String 编号 tags String 标签 description String 描述 region String 区域 author_id String 创建人ID author_name String 创建人名称 owner_id String 责任人ID owner_name String 责任人名称 parent_uri String 父任务URI parent_path String 父任务路径 origin_uri String 源任务URI version_uri String 版本URI branch_uri String 分支URI version_name String 版本名称 creation_date String 创建时间 create_date_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 relation_change_time String 关联关系修改时时间 relation_change_time_timestamp Long 关联关系修改时间时间戳 test_case_condition String 动态任务用例过滤条件 updator_id String 修改人Id updator_name String 修改人名称 relation_changer_id String 关联关系修改人Id service_type Integer 服务类型ID service_type_name String 服务类型名称 tag_list Array of strings 标签名称集合 module_id String 模块ID module_name String 模块名称 module_path String 模块path module_path_name String 模块路径名称 release_dev String 发布版本号 ext_param String 扩展参数 execute_way Integer 执行方式（1：串行，2：并行） execute_type Integer 执行类型（0：冒烟，1：定时） status_code Integer 生命周期状态Code status_name String 生命周期状态名称 result_code Integer 执行结果Code result_name String 执行状态名称 execute_status_code Integer Echo执行状态Code execute_status_name String Echo执行状态名称 executor_id String 执行人ID executor_name String 执行人名称 execute_latest_time String 最近执行时间 execute_latest_time_timestamp Long 最近执行时间时间戳 execute_duration String 执行时长 execute_times Integer 执行次数 project_uuid String 项目ID case_operation_info CaseOperationVo object 任务关联用例信息 assign_case_num Integer 关联用例数 finish_case_num Integer 已完成用例数量 assign_defect_num Integer 关联缺陷数量 task_assign_msg String 任务关联用例变更提示信息 iterator_version_uri String 测试套所属迭代uri，非迭代下创建的测试套返回null result_number_list Array of NameAndValueAndCodeVo objects 用户自定义结果对应的用例数目 finish_date String 测试套完成时间 finish_date_timestamp Long 测试套完成时间戳 plan_start_date String 计划开始时间 plan_start_timestamp Long 计划开始时间戳 plan_end_date String 计划结束时间 plan_end_timestamp Long 计划结束时间戳 expiration_status Integer 测试套超期状态值，分别为：无状态(null)、未超期(0)、即将超期(1)、已超期(2)、延期完成(3)、按期完成(4) expiration_status_name String 测试套超期状态名称，分别为：无状态(不显示状态)、未超期(Unexpired)、即将超期(About to expire)、已超期(Expired)、延期完成(Delayed completion)、按期完成(On schedule completion) 表7 CaseOperationVo 参数 参数类型 描述 test_cases_info Array of TaskAssignCaseVo objects 用例关联信息 set_up_cases_info Array of TaskAssignCaseVo objects 前置用例关联信息 tear_down_cases_info Array of TaskAssignCaseVo objects 后置用例关联信息 表8 TaskAssignCaseVo 参数 参数类型 描述 sort Integer 排序顺序 case_uri String 用例uri is_available Integer 是否可用 test_case_name String 用例名称 test_case_number String 用例编号 表9 NameAndValueAndCodeVo 参数 参数类型 描述 name String 名称 value Integer 值 code String 编码 表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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

URI GET /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 Query参数 参数 是否必选 参数类型 描述 version_uri 否 String 分支/迭代uri

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String 参数解释 success|error; 取值范围 success|error result ResultValueStringForOk object 请求结果 表4 ResultValueStringForOk 参数 参数类型 描述 value String 参数解释 ok 取值范围 不涉及 状态码：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 表5 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueHomePageOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表6 ResultValueHomePageOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value HomePageOverviewVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表7 HomePageOverviewVo 参数 参数类型 描述 case_completion_rate CaseCompletionRateVo object 计算用例完成率 case_pass_rate CasePassRateVo object 计算用例通过率 defect_status DefectStatusVo object 统计缺陷信息，组装缺陷状态分组信息 defect_severity DefectSeverityVo object 统计缺陷信息，组装缺陷重要程度分组信息 表8 CaseCompletionRateVo 参数 参数类型 描述 total Integer 总用例数 completion_rate String 用例完成率 status_number_list Array of NameAndValueVo objects 用户自定义状态对应的用例数目 表9 CasePassRateVo 参数 参数类型 描述 pass_rate String 用例通过率 result_number_list Array of NameAndValueVo objects 用户自定义结果对应的用例数目 表10 DefectStatusVo 参数 参数类型 描述 total Integer 缺陷数 not_solved Integer 未关闭缺陷数 status_number_list Array of NameAndValueVo objects 每种状态的名称和对应的数目 表11 DefectSeverityVo 参数 参数类型 描述 total Integer 缺陷数 severity_number_list Array of NameAndValueVo objects 每种重要程度的名称和对应的数目 表12 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表13 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表14 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表15 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表16 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表17 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : { "defect" : { "total" : 2, "not_solved" : 0, "severity_number_list" : [ { "name" : "提示", "value" : 2 } ] }, "case_pass_rate" : { "pass_rate" : "0.0%", "result_number_list" : [ { "name" : "成功", "value" : 2 }, { "name" : "失败", "value" : 2 }, { "name" : "执行中", "value" : 3 }, { "name" : "停止", "value" : 1 }, { "name" : "未执行", "value" : 19994 } ] }, "project_type" : "ipd", "issue_cover_rate" : { "epic" : { "testing" : 0, "finished" : 0, "not_tested" : 0, "total_number" : 0, "cover_rate" : "0.0%" }, "feature" : { "testing" : 0, "finished" : 0, "not_tested" : 0, "total_number" : 0, "cover_rate" : "0.0%" }, "story" : { "testing" : 2, "finished" : 0, "not_tested" : 4, "total_number" : 6, "cover_rate" : "0.0%" } } } } }

请求示例 质量报告看板统计 post https://{endpoint}/v4/projects/26927372bbae40b184fe764e7a0d21f7/report/overview { "version_uri" : "v91k0000vgtfg1jk", "module_id" : "994928222970748929,994928245960912896,994928263572795393,994928294128300032,994928330747584512,-2", "pi_filter" : { "all_pi" : true, "pi_sprints" : [ { "pi_id" : "1035314883144495104", "sprints" : [ "" ] }, { "pi_id" : "991653518035169281", "sprints" : [ "991653560740388864", "" ] }, { "pi_id" : "", "sprints" : [ "" ] } ] } }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueOverviewVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表6 ResultValueOverviewVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value OverviewVo object status为failed时，存放只有reason的ApiError对象 reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表7 OverviewVo 参数 参数类型 描述 defect DefectVo object 整体缺陷信息 case_pass_rate CasePassRateVo object 计算用例通过率 case_completion_rate CaseCompletionRateVo object 计算用例完成率 risk_rating RiskRatingVo object 测试计划的风险等级和风险描述 project_type String 项目类型 issue_cover_rate IssueCoverRateVo object 看板项目的需求覆盖率 表8 DefectVo 参数 参数类型 描述 total Integer 缺陷数 not_solved Integer 未关闭缺陷数 severity_number_list Array of NameAndValueVo objects 组装缺陷每种重要程度的名称和对应的数目 表9 CasePassRateVo 参数 参数类型 描述 pass_rate String 用例通过率 result_number_list Array of NameAndValueVo objects 用户自定义结果对应的用例数目 表10 CaseCompletionRateVo 参数 参数类型 描述 total Integer 总用例数 completion_rate String 用例完成率 status_number_list Array of NameAndValueVo objects 用户自定义状态对应的用例数目 表11 NameAndValueVo 参数 参数类型 描述 name String 名称 value Integer 值 表12 RiskRatingVo 参数 参数类型 描述 risk_rating Integer 测试计划的风险等级 risk_description String 测试计划的风险描述 表13 IssueCoverRateVo 参数 参数类型 描述 epic CoverRateVo object epic类型需求覆盖率, 仅scrum项目返回 feature CoverRateVo object feature类型需求覆盖率, 仅scrum项目返回 story CoverRateVo object story类型需求覆盖率, 仅scrum项目返回 summary CoverRateVo object 需求覆盖率(scrum项目仅返回epic、feature、story。非scrum项目仅返回summary) 表14 CoverRateVo 参数 参数类型 描述 testing Integer 统计测试中的需求 finished Integer 统计已完成的需求 not_tested Integer 统计未测试的需求 total_number Integer 计算需求总数 cover_rate String 需求覆盖率 表15 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表16 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表17 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表18 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表19 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

响应示例 状态码：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", "create_time" : "2024-09-12 11:25:56", "create_time_timestamp" : 1726111556000, "update_time" : "2024-09-12 11:25:56", "update_time_timestamp" : 1726111556000 } ] } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueCustomizedFilterVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueCustomizedFilterVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value CustomizedFilterVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 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 表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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

响应示例 状态码：200 OK { "value" : [ { "id" : 1, "name" : "功能性测试" }, { "id" : 4, "name" : "性能测试" }, { "id" : 2, "name" : "兼容性测试" }, { "id" : 15, "name" : "易用性测试" }, { "id" : 22, "name" : "可靠性测试" }, { "id" : 14, "name" : "安全性测试" }, { "id" : 21, "name" : "可服务性测试" } ] }

URI GET /GT3KServer/v4/{project_id}/test-types 表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 IntegerIdAndNameVo objects 测试类型信息 表4 IntegerIdAndNameVo 参数 参数类型 描述 id Integer 参数解释 数据库存储数字 取值范围 不涉及 name String 参数解释 页面显示值 取值范围 不涉及 状态码：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参数 参数 参数类型 描述 status String success|error result ResultValueExecuteTaskVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueExecuteTaskVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value ExecuteTaskVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 ExecuteTaskVo 参数 参数类型 描述 flag Boolean 标志 uri String URI task_result_vo TaskResultVo object 实际的数据类型：单个对象，集合 或 NULL update_case_uri_list Array of strings 更新用例 test_case_result_list Array of TestResultVo objects 用例结果列表 表6 TaskResultVo 参数 参数类型 描述 uri String URI name String 测试套名称 description String 描述 owner String 责任人 creator String 创建人id updator String 更新人 task_uri String 任务uri owner_name String 责任人名称 release_dev String 发布版本号 version_uri String 分支/迭代uri creator_name String 创建人名称 create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 updator_name String 更新人名称 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 start_time String 开始时间 start_time_timestamp Long 开始时间时间戳 end_time String 结束时间 end_time_timestamp Long 开始时间时间戳 result_code Integer 执行结果Code result_name String 测试结果名称 finish_flg Integer 测试任务是否执行完成（0：未完成，1：已完成） project_uuid String 项目id 表7 TestResultVo 参数 参数类型 描述 uri String 结果URI name String 用例结果名称 author String 创建人ID rank Integer 级别 result Integer 测试结果Code round Integer 执行批次 preparation String 前置条件 description String 描述 region String 逻辑Region steps Array of ResultStepVo objects 测试步骤信息 number String 用例结果编号 author_name String 创建人名称 begin_time String 执行开始时间 begin_time_timestamp Long 执行开始时间时间戳 end_time String 执行结束时间 end_time_timestamp Long 执行结束时间时间戳 creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 last_modified String 最后修改时间 last_modified_timestamp Long 最后修改时间 last_change_time String 最后变更时间 last_change_time_timestamp Long 最后变更时间 dfx_test_result String DFX测试结果 failure_cause String 失败原因 parent_uri String 父节点URI(分支用例URI或迭代用例URI) test_case_uri String 分支用例URI test_case_name String 用例名称 task_uri String 测试任务URI result_name String 测试结果 test_result_ae String 是否自动化执行 executor_id String 执行人ID executor_name String 执行人名称 task_id String 执行机任务ID execute_id String 执行ID time_cost Integer 执行耗时 step_txt String 测试步骤 step_expect String 测试步骤期望结果 step_actual String 测试步骤实际结果 step_result String 测试步骤结果 release_dev String 版本号 creation_version_uri String 创建版本URI version_uri String 版本URI project_uuid String 项目ID report_url String 第三方过来的执行结果，返回跳转到第三方的url test_case_number String 测试用例编号 service_type String 测试类型 表8 ResultStepVo 参数 参数类型 描述 result String 结果 test_step String 测试步骤 expect_result String 预期结果 actual_result String 实际结果 result_name String 测试结果名称 表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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

功能介绍 自然语言处理包含如下子服务。 机器翻译 （Machine Translation，简称MT），为用户提供快速准确的翻译服务，帮助用户跨语言沟通，可用于文档翻译等场景中。 优势 功能全面 提供多种常用自然语言类的算法模型及解决方案，可覆盖不同行业的各类需求。 高效准确 可快速分析大数据量的文本，深度理解文本语义，更加准确的挖掘出文本中的关键信息。 简单易用 简单易用的API接口。无需下载SDK、购买服务器，支持跨平台调用。丰富的产品种类，可一站式开通、部署。 稳定可靠 故障自动迁移，服务可用性达99.95%，保障业务连续。数据多副本，数据持久性99.99995%，保障数据不丢失。

欠费 按需购买的接口是按照API调用次数阶梯价格计费，当余额不足，无法对当前产生费用进行扣费，就会导致欠费，欠费后有保留期。您续费后可继续正常使用，请注意在保留期进行的续费，是以原到期时间作为生效时间，您应当支付从进入保留期开始到续费时的服务费用。 您账号欠费后，会导致部分操作受限，建议您尽快续费。具体受限操作如下所示： 按需方式的API接口不可调用 不可重置套餐包方式的API接口，例如“10万次基础套餐包”，在欠费后如果套餐包有剩余，可继续使用，但不可购买，也不可续期 每日或每月可重置套餐包方式的API接口，例如“每月20000次基础套餐包”，在调用超过每日或每月限额导致欠费，会进入保留期，保留期后会被冻结，无法使用该套餐包 无法开通服务