华为云用户手册

响应参数 状态码：201 表3 响应Body参数 参数 参数类型 描述 service_id Integer 参数解释 接口调用成功返回的服务id 取值范围 不涉及 service_name String 参数解释 接口调用成功返回的服务名 取值范围 不涉及 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及

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

请求示例 查询时段内用例的执行情况 post https://{endpoint}/v1/efdb403066474ab08836b9eeaaa23bca/testcases/execute-info/statistic-by-user { "offset" : 0, "limit" : 10, "execute_start_time" : "2023-01-01T00:00:00+08:00", "execute_end_time" : "2023-01-01T23:59:59+08:00" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 参数解释: 符合条件的所有记录数 取值范围: 起始记录数大于实际总条数时，值为0 values Array of ExternalUserExecuteInfo objects 参数解释: 时段内用例的执行情况 取值范围: 不涉及 表5 ExternalUserExecuteInfo 参数 参数类型 描述 executor NameAndIdVo object 参数解释: 执行人信息 取值范围: 不涉及 execute_count Integer 参数解释: 执行用例数 取值范围: 不涉及 表6 NameAndIdVo 参数 参数类型 描述 id String 参数解释: ID 取值范围: 不涉及 name 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 参数解释 接口调用失败错误信息 取值范围 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 是 Integer 参数解释: 起始偏移量,表示从此偏移量开始查询 约束限制: 不涉及 取值范围: 0-20000 默认取值: 不涉及 limit 是 Integer 参数解释: 每页显示的条目数量 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及 execute_start_time 是 String 参数解释: 用例执行时间段开始 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及 execute_end_time 是 String 参数解释: 用例执行时间段截止 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 参数解释 success|error; 取值范围 success|error result ResultValueStringForOk object 请求结果 表5 ResultValueStringForOk 参数 参数类型 描述 value String 参数解释 ok 取值范围 不涉及 状态码：400 表6 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表7 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

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

URI POST /v1/projects/{project_id}/testcases/batch-delete 表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/testcases/batch-delete { "service_id" : 13, "testcase_id_list" : [ "97b82412f1ca4628803b918c27ed09de", "97b82412f1ca4628803b918c27ed09de", "97b82412f1ca4628803b918c27ed09de" ] }

响应参数 状态码：204 No Content 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 service_id 是 Integer 参数解释: 测试用例类型ID，指定指定对应类型的测试用例ID 约束限制: 需要与testcase_id_list中提供的用例的执行方式一致 取值范围: 大于0整数 默认取值: 不涉及 testcase_id_list 是 Array of strings 参数解释: 用例uri数组,测试用例唯一标识，测试用例详情页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testcase?branch_id={branch_id}&case_id={case_id}&detail=base中case_id变量的值 约束限制: 数组小于50个 取值范围: uri长度11-34位字符（字母和数字）,数组小于50个 默认取值: 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueListLabelVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueListLabelVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of LabelVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 LabelVo 参数 参数类型 描述 uri String uri主键 region String 逻辑region label_name String 标签名称 service_type String 服务类型 resource_type String 所属资源类型（TestCase：用例，Task：测试套） 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 参数解释: 接口调用失败错误信息 取值范围: 不涉及

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : [ { "uri" : "v91j0000vpmr57j9", "region" : "cn-north-7", "label_name" : "对对对对对对多", "resource_type" : "TestCase" }, { "uri" : "v91j0vpmr57j939o", "region" : "cn-north-7", "label_name" : "咕咕咕咕咕咕过过过过", "resource_type" : "TestCase" } ] } }

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

响应示例 状态码：500 Internal Server Error { "error_code" : "CLOUDTEST.00000001", "error_msg" : "接口调用失败错误信息", "error_detail" : { "failed" : [ { "error_code" : "CLOUDTEST.00000001", "error_msg" : "返回的错误信息", "testcase_id" : "efdb403066474ab08836b9eeaaa23bca" } ] } }

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : { "create_count" : 0, "design_count" : 1, "execute_count" : 0, "report_count" : 0, "total_count" : 1 } } }

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

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

请求示例 新增测试套任务 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 参数解释: 错误信息 取值范围: 非必返 request_id String 参数解释: 请求的唯一id 取值范围: 非必返 address String 参数解释: 本次请求的受理的服务地址。 取值范围: 非必返 表8 ResultValueString 参数 参数类型 描述 value String 参数解释 resultObject 取值范围 不涉及 表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的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表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位，包含大小写字母、数字 默认取值: 不涉及

响应参数 状态码：204 No Content 状态码：400 表3 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及

URI GET /v4/{project_id}/resources/{resource_uri}/exist 表1 路径参数 参数 是否必选 参数类型 描述 resource_uri 是 String 需求或缺陷的id project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 version_uri 是 String 测试计划uri type 是 Integer 关联类型(需求：3，缺陷：4)

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

响应示例 状态码：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, "project_uuid" : "3d2378e0fc504c638f48b21377d6add1" } ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 work_item_ids 否 Array of strings 参数解释 需求/缺陷ID列表 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 project_uuid 否 String 参数解释 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制 不涉及 取值范围 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值 不涉及 version_uri 否 String 参数解释 版本uri 约束限制 不涉及 取值范围 11到34位英文或数字 默认取值 不涉及 relate_type 否 String 参数解释 关联关系类型 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 参数解释 success|error; 取值范围 success|error result ResultValueStringForOk object 请求结果 表5 ResultValueStringForOk 参数 参数类型 描述 value String 参数解释 ok 取值范围 不涉及 状态码：400 表6 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表7 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

响应示例 状态码：201 OK [ { "detail" : [ { "added" : [ { "id" : "ID", "name" : "名称" } ], "deleted" : [ { "id" : "ID", "name" : "名称" } ], "journalized_type" : "plan", "type" : "resource/attribute", "updated" : [ { "attribute_type" : "name", "new_value" : "tester", "old_value" : "test" } ] } ], "operate_time" : "2021-07-10", "operator" : { "id" : "ID", "name" : "名称" }, "plan_id" : "c7c2ddf2ea914164ac6ee76bf11a30ea", "project_id" : "9b26f58ec29943f681804a6628779a23" } ]

URI GET /v1/projects/{project_id}/plans/{plan_id}/journals 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，项目唯一标识，固定长度32位字符，获取方式请参见获取项目ID。 约束限制: 项目唯一标识，固定长度32位 取值范围: 字母、数字 默认取值: 不涉及 plan_id 是 String 参数解释: 测试计划id，测试计划的唯一标识，长度11-34位字符 约束限制: 测试计划唯一标识，长度11-34位 取值范围: 字母、数字 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Long 参数解释: 起始偏移量，表示从此偏移量开始查询， offset大于等于0 参数限制: 大于等于0 取值范围: 0-2000000 默认取值: 不涉及 limit 是 Long 参数解释: 每页显示的条目数量,最大支持200条 参数限制: 大于等于0 取值范围: 1-200 默认取值: 不涉及