发布/迭代计划列表查询 - ListPlan
功能介绍
发布/迭代计划列表查询
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
GET /v1/planservice/projects/{project_id}/plans/query
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32个字符,由英文字母和数字组成。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key_word | 否 | String | 参数解释: 发布/迭代名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| updated_time_interval | 否 | String | 参数解释: 更新发布/迭代时间,unix时间戳,单位:毫秒 样例:1576114296000,1576114396000 约束限制: 起止时间均为13位的时间戳字符串,使用英文逗号分割。 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| x-auth-token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为10-32768的字符串。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 返回状态。 取值范围: |
| message | String | 参数解释: 提示信息。 取值范围: 不涉及。 |
| result | Array of PlanResponseResult objects | 参数解释: 计划列表,包含发布及其子迭代的完整信息。 |
| page | page object | 参数解释: 计划列表分页信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 发布、迭代、里程碑的ID 取值范围: 不涉及 |
| title | String | 参数解释: 标题 取值范围: 不涉及 |
| category | String | 参数解释: 分类,枚举类型 取值范围: |
| description | String | 参数解释: 描述 取值范围: 不涉及 |
| state | String | 参数解释: 作废标识,枚举类型。 取值范围: |
| status | String | 参数解释: 发布/迭代的状态,枚举类型。 取值范围: |
| children | Array of PlanResponseResult objects | 参数解释: 子项目迭代信息 |
| created_by | String | 参数解释: 创建人ID 取值范围: 不涉及 |
| modified_by | String | 参数解释: 最近更新人ID。 取值范围: 不涉及 |
| plan_start_date | Long | 参数解释: 计划开始时间,unix时间戳,单位:毫秒。 取值范围: 不涉及 |
| plan_end_date | Long | 参数解释: 计划完成时间,unix时间戳,单位:毫秒。 取值范围: 不涉及 |
| created_date | Long | 参数解释: 创建时间,unix时间戳,单位:毫秒 取值范围: 不涉及 |
| parent_id | String | 参数解释: 父计划ID,当计划类型为迭代(Iteration)时,用于指定所属的发布计划。 取值范围: 长度为18~19个字符的数字字符串。 |
| baseline | String | 参数解释: 基线状态,枚举类型,标识计划是否已纳入基线管理。 取值范围: |
| workload | String | 参数解释: 预估工作量,用于标识计划所需的人力或时间投入,单位人/天。 取值范围: 最大长度11个字符。 |
| owner | String | 参数解释: 责任人ID,标识计划的负责人。 取值范围: 长度为32位的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| page | Integer | 参数解释: 页码 取值范围: 不涉及 |
| size | Integer | 参数解释: 分页数量 取值范围: 不涉及 |
| count | Integer | 参数解释: 当前页数量 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述信息。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v1/planservice/projects/{project_id}/plans/query?key_word=gzy&updated_time_interval=1706845235000,1706845835000 响应示例
状态码:200
{
"status" : "success",
"message" : null,
"result" : [ {
"id" : "956200745322848257",
"title" : "IR-01",
"category" : "PI",
"description" : "描述",
"state" : "正在工作",
"status" : "ended",
"children" : null,
"created_by" : "a360371833bf4c558f796fd707b44daf",
"modified_by" : "a360371833bf4c558f796fd707b44daf",
"plan_start_date" : 1706845715000,
"plan_end_date" : 1706845715000,
"created_date" : 1706845715000,
"parent_id" : "956239067176935424",
"baseline" : "baselined",
"workload" : "workload",
"owner" : "a360371833bf4c558f796fd707b44daf"
} ],
"page" : {
"page" : 1,
"size" : 10,
"count" : 1
}
} 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.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class ListPlanSolution { 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); ProjectManClient client = ProjectManClient.newBuilder() .withCredential(auth) .withRegion(ProjectManRegion.valueOf("<YOUR REGION>")) .build(); ListPlanRequest request = new ListPlanRequest(); request.withProjectId("{project_id}"); try { ListPlanResponse response = client.listPlan(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 huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkprojectman.v4 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 = ProjectManClient.new_builder() \ .with_credentials(credentials) \ .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPlanRequest() request.project_id = "{project_id}" response = client.list_plan(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 38 39 40 41 42 43 44 45 46 47 48 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/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 := projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) request := &model.ListPlanRequest{} request.ProjectId = "{project_id}" response, err := client.ListPlan(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询发布/迭代计划列表成功 |
| 400 | 错误信息 |
错误码
请参见错误码。