文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试计划管理/ 查询某个测试计划下的需求树
更新时间:2025-06-26 GMT+08:00
分享

查询某个测试计划下的需求树

功能介绍

查询某个测试计划下的需求列表

调用方法

请参见如何调用API

URI

GET /v1/projects/{project_id}/plans/{plan_id}/issues

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值:

不涉及

plan_id

String

参数解释:

测试计划id,对应测试计划管理页面创建的测试计划对象以及版本管理中创建的版本对象,测试用例列表页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testcase?branch_id={branch_id}&testplan_id={testplan_id}中变量branch_id/testplan_id的值

约束限制:

不涉及

取值范围:

长度11-34位字符(字母和数字)

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

Long

参数解释:

起始偏移量,表示从此偏移量开始查询,

约束限制:

不涉及

取值范围:

offset大于等于0,小于等于2000000。

默认取值:

不涉及

limit

Long

参数解释:

每页显示的条目数量,最大支持100条,表示从此偏移量开始查询,

约束限制:

不涉及

取值范围:

0-100

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of TestPlanIssueDetail objects

参数解释:

项目下某个测试计划关联的需求列表

取值范围:

不涉及

表5 TestPlanIssueDetail

参数

参数类型

描述

end_date

String

参数解释:

预计结束日期

取值范围:

不涉及

iteration

NameAndId object

参数解释:

测试计划迭代编号与迭代名称

取值范围:

不涉及

module

NameAndId object

参数解释:

测试计划迭代编号与迭代名称

取值范围:

不涉及

name

String

参数解释

工作项名称

取值范围:

不涉及

owner

NameAndId object

参数解释:

测试计划迭代编号与迭代名称

取值范围:

不涉及

parent_issue

String

参数解释:

父工作项

取值范围:

不涉及

plan_id

String

参数解释:

测试计划id

取值范围:

不涉及

project_id

String

参数解释:

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

取值范围:

不涉及

region_id

String

参数解释:

region信息

取值范围:

不涉及

severity

NameAndId object

参数解释:

测试计划迭代编号与迭代名称

取值范围:

不涉及

start_date

String

参数解释:

预计开始日期

取值范围:

不涉及

status

NameAndId object

参数解释:

测试计划迭代编号与迭代名称

取值范围:

不涉及

tracker

NameAndId object

参数解释:

测试计划迭代编号与迭代名称

取值范围:

不涉及

workitem_id

String

参数解释:

工作项id

取值范围:

不涉及

表6 NameAndId

参数

参数类型

描述

id

String

参数解释:

对象编号

取值范围:

不涉及

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

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

查询某个测试计划下的需求树

get https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/plans/9b26f58ec29943f681804a6628779a23/issues?offset=1&limit=10

响应示例

状态码:200

OK

[ {
  "end_date" : "2021-12-11 00:00:00",
  "iteration" : {
    "id" : "ID",
    "name" : "名称"
  },
  "module" : {
    "id" : "ID",
    "name" : "名称"
  },
  "name" : "工作项1",
  "owner" : {
    "id" : "ID",
    "name" : "名称"
  },
  "parent_issue" : "4192352",
  "plan_id" : "c7c2ddf2ea914164ac6ee76bf11a30ea",
  "project_id" : "9b26f58ec29943f681804a6628779a23",
  "region_id" : "cn-north-7",
  "severity" : {
    "id" : "ID",
    "name" : "名称"
  },
  "start_date" : "2021-12-10 00:00:00",
  "status" : {
    "id" : "ID",
    "name" : "名称"
  },
  "tracker" : {
    "id" : "ID",
    "name" : "名称"
  },
  "workitem_id" : "4192353"
} ]

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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 ShowIssuesByPlanIdSolution {

    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("<YOUR REGION>"))
                .build();
        ShowIssuesByPlanIdRequest request = new ShowIssuesByPlanIdRequest();
        request.withProjectId("{project_id}");
        request.withPlanId("{plan_id}");
        try {
            ShowIssuesByPlanIdResponse response = client.showIssuesByPlanId(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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = ShowIssuesByPlanIdRequest()
        request.project_id = "{project_id}"
        request.plan_id = "{plan_id}"
        response = client.show_issues_by_plan_id(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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cloudtest.NewCloudtestClient(
        cloudtest.CloudtestClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowIssuesByPlanIdRequest{}
	request.ProjectId = "{project_id}"
	request.PlanId = "{plan_id}"
	response, err := client.ShowIssuesByPlanId(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档