项目下查询测试计划列表v2
功能介绍
项目下查询测试计划列表v2
调用方法
请参见如何调用API。
URI
GET /v2/projects/{project_id}/plans
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID 约束限制 不涉及 取值范围 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
是 |
Integer |
参数解释 起始偏移量,表示从此偏移量开始查询 约束限制 不涉及 取值范围 大于等于0 默认取值 不涉及 |
limit |
是 |
Integer |
参数解释 每页显示的条目数量,最大支持100条,表示从此偏移量开始查询 约束限制 不涉及 取值范围 0-100 默认取值 不涉及 |
name |
否 |
String |
参数解释 模糊查询使用(针对测试计划名称) 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
current_stage |
否 |
String |
参数解释 测试计划所处阶段 约束限制 不涉及 取值范围 create,design,execute,report 默认取值 不涉及 |
fix_version_ids |
否 |
String |
参数解释 测试计划关联的迭代 约束限制 不涉及 取值范围 迭代id以逗号间隔 默认取值 不涉及 |
branch_uri |
否 |
String |
参数解释 分支Uri 约束限制 不涉及 取值范围 不涉及 默认取值 master |
query_all_version |
否 |
Boolean |
参数解释 是否查询所有版本下测试计划 约束限制 不涉及 取值范围 fase:查询branch_uri指定分支下的测试计划,branch_uri为空时默认为master true:查询所有版本下测试计划 默认取值 false |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制 不涉及 取值范围 字符串长度不少于1,不超过100000 默认取值 不涉及 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of TestPlanDetail objects |
项目下查询测试计划列表返回结构 |
参数 |
参数类型 |
描述 |
---|---|---|
creator |
creator object |
参数解释: 测试计划创建者信息 取值范围: 不涉及 |
current_stage |
String |
参数解释: 当前测试计划所处的阶段 取值范围: 不涉及 |
design_stage |
design_stage object |
参数解释: 测试计划设计阶段信息 取值范围: 不涉及 |
end_date |
Date |
参数解释: 测试计划截止时间 取值范围: 不涉及 |
execute_stage |
execute_stage object |
参数解释: 测试计划执行阶段信息 取值范围: 不涉及 |
expire_day |
Integer |
参数解释: 获取超期时间,正值表示已超期 取值范围: 不涉及 |
finish_date |
Date |
参数解释: 测试计划实际完成时间(测试计划实际完成指测试计划下所有测试用例处于完成状态) 取值范围: 不涉及 |
iteration |
NameAndId object |
参数解释: 测试计划迭代编号与迭代名称 取值范围: 不涉及 |
name |
String |
参数解释: 测试计划名称 取值范围: 不涉及 |
owner |
owner object |
参数解释: 测试计划处理者信息 取值范围: 不涉及 |
plan_id |
String |
参数解释: 测试计划id 取值范围: 不涉及 |
project_id |
String |
参数解释: 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及 |
report_stage |
report_stage object |
参数解释: 报告阶统计数据 取值范围: 不涉及 |
start_date |
Date |
参数解释: 测试计划开始时间 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 测试计划创建者id 取值范围: 不涉及 |
nick_name |
String |
参数解释: 测试计划创建者的昵称 取值范围: 当用户未设置昵称时不返回该字段 |
user_name |
String |
参数解释: 测试计划创建者的用户名称 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
case_count |
Integer |
参数解释: 用例个数 取值范围: 不涉及 |
issue_count |
Integer |
参数解释: 需求个数 取值范围: 不涉及 |
issue_covered_count |
String |
参数解释: 已被用例关联的需求个数 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
case_pass_rate |
String |
参数解释: 用例通过率,按用例结果计算 取值范围: 不涉及 |
completed_defect_count |
Integer |
参数解释: 已完成缺陷个数 取值范围: 不涉及 |
defect_count |
Integer |
参数解释: 缺陷个数 取值范围: 不涉及 |
executed_case_count |
Integer |
参数解释: 已执行用例数, 按用例状态统计 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 测试计划处理者id 取值范围: 不涉及 |
name |
String |
参数解释: 测试计划处理者名称,优先返回nickName,不存在则返回userName 取值范围: 不涉及 |
nick_name |
String |
参数解释: 测试计划处理者的昵称,当用户未设置昵称时不返回该字段 取值范围: 不涉及 |
user_name |
String |
参数解释: 测试计划处理者的用户名称 取值范围: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
get https://{endpoint}/v2/projects/efdb403066474ab08836b9eeaaa23bca/plans?offset=1&limit=10&name¤t_stage
响应示例
状态码:201
OK
[ {
"creator" : {
"id" : "efdb403066474ab08836b9eeaaa23bca",
"nick_name" : "测试Tester",
"user_name" : "测试Tester"
},
"current_stage" : "design",
"design_stage" : {
"case_count" : 2,
"issue_count" : 0,
"issue_covered_count" : "0"
},
"end_date" : "2021-07-10",
"execute_stage" : {
"case_pass_rate" : "0.00%",
"completed_defect_count" : 0,
"defect_count" : 0,
"executed_case_count" : 0
},
"expire_day" : -4,
"finish_date" : "2021-07-10",
"iteration" : {
"id" : "ID",
"name" : "名称"
},
"name" : "测试",
"owner" : {
"id" : "efdb403066474ab08836b9eeaaa23bca",
"name" : "测试Tester",
"nick_name" : "测试Tester",
"user_name" : "测试Tester"
},
"plan_id" : "c7c2ddf2ea914164ac6ee76bf11a30ea",
"project_id" : "9b26f58ec29943f681804a6628779a23",
"report_stage" : {
"case_complete_rate" : "100.00%"
},
"start_date" : "2021-07-10"
} ]
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 |
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 ShowPlanListSolution {
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();
ShowPlanListRequest request = new ShowPlanListRequest();
request.withProjectId("{project_id}");
try {
ShowPlanListResponse response = client.showPlanList(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 |
# 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 = ShowPlanListRequest()
request.project_id = "{project_id}"
response = client.show_plan_list(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 |
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.ShowPlanListRequest{}
request.ProjectId = "{project_id}"
response, err := client.ShowPlanList(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。