# 查询迭代计划列表，包含统计信息（1.0） - ListIterators #### 功能介绍 此接口用于在项目下查询计划列表,同页面 测试 -\> 测试计划 -\> 右侧列表页 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /GT3KServer/v4/iterators/batch-query #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释** 迭代计划名称（支持模糊搜索） **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | filter | 否 | [IteratorListFilterInfo] object | **参数解释** 过滤信息 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | own | 否 | Boolean | **参数解释** 是否是我的 **约束限制** 不涉及 **取值范围** true:是 false:否 **默认取值** 不涉及 | | branch_uri | 否 | String | **参数解释** 分支URI **约束限制** 不涉及 **取值范围** 11-34位字母/数字 **默认取值** 不涉及 | | iterator_uri | 否 | String | **参数解释** 迭代计划URI **约束限制** 不涉及 **取值范围** 11-34位字母/数字 **默认取值** 不涉及 | | owner_ids | 否 | Array of strings | **参数解释** 迭代计划责任人集合 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | project_uuid | 是 | String | **参数解释** 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **约束限制** 不涉及 **取值范围** 32位字符（字母和数字） **默认取值** 不涉及 | | current_stage | 否 | String | **参数解释** 迭代计划所处节点 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | page_no | 否 | Integer | **参数解释** 当前页数 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | page_size | 否 | Integer | **参数解释** 每页条数 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | 表3IteratorListFilterInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pi_sprints | 否 | Array of [IssueListPiFilterInfo] objects | **参数解释** pi过滤条件 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | plan_end_date_start | 否 | String | **参数解释** 计划结束间过滤开始时间点 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | plan_end_date_end | 否 | String | **参数解释** 计划结束时间过滤结束时间点 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | 表4IssueListPiFilterInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | sprints | 否 | Array of strings | **参数解释** 迭代列表 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | pi_id | 否 | String | **参数解释** pi的id **约束限制** 字母及数字组合 **取值范围** 长度不超过128位的字符串 层级关系：pi -\> 迭代 -\> 需求 **默认取值** 不涉及 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释** 总数 **取值范围** 不小于1的正整数 | | page_no | Integer | **参数解释** 分页编码 **取值范围** 大于0且小于100的正整数 | | page_size | Integer | **参数解释** 分页大小 **取值范围** 大于零且小于20000的正整数 | | value | Array of [IteratorVersionSummaryVo] objects | **参数解释** 请求返回的数据 **取值范围** 不涉及 | 表6IteratorVersionSummaryVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | uri | String | **参数解释** 资源uri **取值范围** 不涉及 | | type | String | **参数解释**: 资源类型 **取值范围**: - TestCase，用例。 - Task，任务。 - TestVersion，分支。 - IteratorTestCase，迭代用例。 | | author | String | **参数解释** 创建人 **取值范围** 不涉及 | | name | String | **参数解释** 名称 **取值范围** 不涉及 | | rank | Integer | **参数解释** 级别 **取值范围** 不涉及 | | version | String | **参数解释** 待测版本 **取值范围** 不涉及 | | owner | String | **参数解释** 处理者ID **取值范围** 不涉及 | | creator | String | **参数解释** 创建人ID **取值范围** 不涉及 | | iterations | String | **参数解释** 关联迭代 **取值范围** 不涉及 | | description | String | **参数解释** 描述 **取值范围** 不涉及 | | region | String | **参数解释** 区域 **取值范围** 不涉及 | | last_modifier | String | **参数解释** 最后修改人 **取值范围** 不涉及 | | last_modified | String | **参数解释** 最后修改时间 **取值范围** 不涉及 | | last_modified_timestamp | Long | **参数解释** 修改时间时间戳 **取值范围** 时间戳格式，单位为毫秒 | | last_change_time | String | **参数解释** 最后变更时间 **取值范围** 时间格式为"yyyy-MM-dd HH:mm:ss" | | 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 | **参数解释** 编号 **取值范围** 不涉及 | | is_master | Integer | **参数解释** 是否为Master分支 **取值范围** 不涉及 | | is_iterator | Integer | **参数解释** 是否为迭代 **取值范围** 不涉及 | | plan_start_date | String | **参数解释** 开始时间 **取值范围** 不涉及 | | plan_end_date | String | **参数解释** 结束时间 **取值范围** 不涉及 | | service_id | String | **参数解释** 微服务ID **取值范围** 不涉及 | | service_name | String | **参数解释** 微服务名 **取值范围** 不涉及 | | pbi_id | String | **参数解释** PBI ID **取值范围** 不涉及 | | pbi_name | String | **参数解释** PBI信息 **取值范围** 不涉及 | | plan_id | String | **参数解释** 计划ID **取值范围** 不涉及 | | metric_pbi_ids | String | **参数解释** 度量PBI ID **取值范围** 不涉及 | | metric_pbi_id_names | String | **参数解释** 度量PBI名称 **取值范围** 不涉及 | | last_syn_date | String | **参数解释** 最后同步时间 **取值范围** 不涉及 | | is_closed | String | **参数解释** 版本是否关闭 **取值范围** 不涉及 | | asyn_git | String | **参数解释** 是否同步git库 **取值范围** 不涉及 | | schema_no | Integer | **参数解释** schema编号 **取值范围** 不涉及 | | finish_date | String | **参数解释** 迭代实际完成时间 **取值范围** 不涉及 | | owner_name | String | **参数解释** 处理者名称 **取值范围** 不涉及 | | creator_name | String | **参数解释** 创建人名称 **取值范围** 不涉及 | | current_stage | String | **参数解释** 当前所处阶段 **取值范围** 不涉及 | | service_types | String | **参数解释** 服务类型 **取值范围** 不涉及 | | risk_rating | Integer | **参数解释** 风险等级 **取值范围** 不涉及 | | risk_des | String | **参数解释** 风险描述 **取值范围** 不涉及 | | project_uuid | String | **参数解释** 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **取值范围** 不涉及 | | domain_id | String | **参数解释** 租户ID **取值范围** 不涉及 | | pi_id | String | **参数解释** pi的id **取值范围** 不涉及 | | start_date | String | **参数解释** 计划开始时间 **取值范围** 不涉及 | | start_date_timestamp | Long | **参数解释** 计划开始时间时间戳 **取值范围** 不涉及 | | end_date | String | **参数解释** 计划结束时间 **取值范围** 不涉及 | | end_date_timestamp | Long | **参数解释** 计划结束时间时间戳 **取值范围** 不涉及 | | actual_start_date | String | **参数解释** 实际开始时间 **取值范围** 不涉及 | | actual_start_date_timestamp | Long | **参数解释** 实际开始时间时间戳 **取值范围** 不涉及 | | actual_end_date | String | **参数解释** 实际完成时间 **取值范围** 不涉及 | | actual_end_date_timestamp | Long | **参数解释** 实际开始时间时间戳 **取值范围** 不涉及 | | is_expired | String | **参数解释** 是否超期 **取值范围** 不涉及 | | expired_info | String | **参数解释** 计划过期信息,空代表不超期，否则给出具体超期信息 **取值范围** 不涉及 | | stages | Array of strings | **参数解释** 迭代计划，默认包含design,execute,report **取值范围** 不涉及 | | design | [DesignSummaryVo] object | **参数解释** 设计总览 **取值范围** 不涉及 | | execute | [ExecuteSummaryVo] object | **参数解释** 执行情况总览 **取值范围** 不涉及 | | report | [ReportSummaryVo] object | **参数解释** 报告总览 **取值范围** 不涉及 | | branch_uri | String | **参数解释** 所属分支URI **取值范围** 不涉及 | | branch_name | String | **参数解释** 所属分支名称 **取值范围** 不涉及 | 表7DesignSummaryVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | issue_num | Integer | **参数解释** 需求总数 **取值范围** 不涉及 | | issue_cover_num | Integer | **参数解释** 已覆盖需求数 **取值范围** 不涉及 | | case_num | Integer | **参数解释** 用例数 **取值范围** 不涉及 | 表8ExecuteSummaryVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | execute_case_num | Integer | **参数解释** 已执行用例数,单位：条 **取值范围** 不涉及,单位：条 | | defect_num | Integer | **参数解释** 缺陷总数 **取值范围** 不涉及 | | completed_defect_num | Integer | **参数解释** 已完成缺陷数 **取值范围** 不涉及 | | case_success_rate | String | **参数解释** 测试用例通过率 **取值范围** 不涉及 | | case_execution_rate | String | **参数解释** 用例执行率 **取值范围** 不涉及 | 表9ReportSummaryVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | case_success_rate | String | **参数解释** 用例通过率 **取值范围** 不涉及 | | case_complete_rate | String | **参数解释** 用例完成率 **取值范围** 不涉及 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 业务失败的错误码 **取值范围**: 不涉及 | | reason | String | **参数解释**: 业务失败的提示内容 **取值范围**: 不涉及 | **状态码：401** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 业务失败的错误码 **取值范围**: 不涉及 | | reason | String | **参数解释**: 业务失败的提示内容 **取值范围**: 不涉及 | **状态码：404** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 业务失败的错误码 **取值范围**: 不涉及 | | reason | String | **参数解释**: 业务失败的提示内容 **取值范围**: 不涉及 | **状态码：500** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 业务失败的错误码 **取值范围**: 不涉及 | | reason | String | **参数解释**: 业务失败的提示内容 **取值范围**: 不涉及 | #### 请求示例 ``` POST https://{endpoint}/GT3KServer/v4/iterators/batch-query { "project_uuid" : "761e569574894180b3ecadc9d9df52b6", "branch_uri" : "v901000106dij34m", "name" : "计划1", "current_stage" : "", "page_no" : 1, "page_size" : 10 } ``` #### 响应示例 **状态码：200** OK ``` { "total" : 1, "page_no" : 1, "page_size" : 10, "value" : [ { "uri" : "v901000107paa4eo", "type" : "TestVersion", "author" : "85f7cd3cd8784307a5bb194321bef3c1", "name" : "计划1", "version" : "基线_版本", "owner" : "85f7cd3cd8784307a5bb194321bef3c1", "creator" : "85f7cd3cd8784307a5bb194321bef3c1", "iterations" : "[]", "region" : { "region" : null }, "last_modifier" : "85f7cd3cd8784307a5bb194321bef3c1", "last_modified" : "2025-02-26 10:55:32", "last_modified_timestamp" : 1740538532000, "last_change_time" : "2025-02-26 10:55:32", "version_uri" : "v901000106dij34m", "parent_uri" : "v901000106dij34m", "parent_path" : "/761e569574894180b3ecadc9d9df52b6/v901000106dij34m/", "creation_version_uri" : "v901000106dij34m", "creation_date" : "2025-02-07 15:44:59", "creation_date_timestamp" : 1738914299000, "author_name" : "wtt_apitest", "is_master" : 0, "is_iterator" : 1, "plan_start_date" : "2025-02-07 00:00:00", "plan_end_date" : "2025-02-28 23:59:59", "service_id" : "761e569574894180b3ecadc9d9df52b6", "service_name" : "APITest（勿删）", "schema_no" : 9, "owner_name" : "wtt_apitest", "creator_name" : "wtt_apitest", "current_stage" : "execute", "service_types" : "[\"0\",\"1\",\"12\",\"7\",\"8\"]", "risk_rating" : 0, "project_uuid" : "761e569574894180b3ecadc9d9df52b6", "pi_id" : "notSelected", "start_date" : "2025-02-07", "start_date_timestamp" : 1738857600000, "end_date" : "2025-02-28", "end_date_timestamp" : 1740758399000, "actual_start_date" : "2025-02-07", "actual_start_date_timestamp" : 1738914359000, "is_expired" : "0", "expired_info" : "即将超期", "stages" : [ "design", "execute", "report" ], "design" : { "issue_num" : 2, "issue_cover_num" : 2, "case_num" : 3 }, "execute" : { "execute_case_num" : 3, "defect_num" : 2, "completed_defect_num" : 0, "case_success_rate" : "66.7%", "case_execution_rate" : "100.0%" }, "report" : { "case_success_rate" : "66.7%", "case_complete_rate" : "66.7%" }, "branch_uri" : "v901000106dij34m", "branch_name" : "基线" } ] } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cloudtest.v1.region.CloudtestRegion; import com.huaweicloud.sdk.cloudtest.v1.*; import com.huaweicloud.sdk.cloudtest.v1.model.*; public class ListIteratorsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CloudtestClient client = CloudtestClient.newBuilder() .withCredential(auth) .withRegion(CloudtestRegion.valueOf("")) .build(); ListIteratorsRequest request = new ListIteratorsRequest(); IteratorVersionsQueryInfo body = new IteratorVersionsQueryInfo(); body.withPageSize(10); body.withPageNo(1); body.withCurrentStage(""); body.withProjectUuid("761e569574894180b3ecadc9d9df52b6"); body.withBranchUri("v901000106dij34m"); body.withName("计划1"); request.withBody(body); try { ListIteratorsResponse response = client.listIterators(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` #### Python ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcloudtest.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CloudtestClient.new_builder() \ .with_credentials(credentials) \ .with_region(CloudtestRegion.value_of("")) \ .build() try: request = ListIteratorsRequest() request.body = IteratorVersionsQueryInfo( page_size=10, page_no=1, current_stage="", project_uuid="761e569574894180b3ecadc9d9df52b6", branch_uri="v901000106dij34m", name="计划1" ) response = client.list_iterators(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cloudtest.CloudtestClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cloudtest.NewCloudtestClient(hcClient) request := &model.ListIteratorsRequest{} pageSizeIteratorVersionsQueryInfo:= int32(10) pageNoIteratorVersionsQueryInfo:= int32(1) currentStageIteratorVersionsQueryInfo:= "" branchUriIteratorVersionsQueryInfo:= "v901000106dij34m" nameIteratorVersionsQueryInfo:= "计划1" request.Body = &model.IteratorVersionsQueryInfo{ PageSize: &pageSizeIteratorVersionsQueryInfo, PageNo: &pageNoIteratorVersionsQueryInfo, CurrentStage: ¤tStageIteratorVersionsQueryInfo, ProjectUuid: "761e569574894180b3ecadc9d9df52b6", BranchUri: &branchUriIteratorVersionsQueryInfo, Name: &nameIteratorVersionsQueryInfo, } response, err := client.ListIterators(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudTest/sdk?api=ListIterators)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。