# 发布/迭代计划列表查询 - ListPlan #### 功能介绍 发布/迭代计划列表查询 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-projectman/projectman_api_1002.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-projectman/projectman_03_Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsreq:plan:list | List | - | - codeartsreq:Model - codeartsreq:ProjectId | - | - | #### URI GET /v1/planservice/projects/{project_id}/plans/query 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目的32位uuid，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取，响应消息体中的**project_id**字段的值就是项目ID。 **约束限制**： 32个字符，由英文字母和数字组成。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key_word | 否 | String | **参数解释：** 发布/迭代名称 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | updated_time_interval | 否 | String | **参数解释：** 更新发布/迭代时间，unix时间戳，单位：毫秒 样例：1576114296000,1576114396000 **约束限制：** 起止时间均为13位的时间戳字符串，使用英文逗号分割。 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | x-auth-token | 是 | String | **参数解释**： 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及。 **取值范围**： 长度为10-32768的字符串。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**： 返回状态。 **取值范围**： - success：查询计划列表成功 - error：查询计划列表失败 | | message | String | **参数解释**： 提示信息。 **取值范围**： 不涉及。 | | result | Array of [PlanResponseResult] objects | **参数解释**： 计划列表，包含发布及其子迭代的完整信息。 | | page | [page] object | **参数解释**： 计划列表分页信息。 | 表5PlanResponseResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 发布、迭代、里程碑的ID **取值范围：** 不涉及 | | title | String | **参数解释：** 标题 **取值范围：** 不涉及 | | category | String | **参数解释：** 分类，枚举类型 **取值范围：** - PI：发布 - Iteration：迭代 - PlanMilestone：里程碑 | | description | String | **参数解释：** 描述 **取值范围：** 不涉及 | | state | String | **参数解释：** 作废标识，枚举类型。 **取值范围：** - 正在工作：可正常操作的发布。 - 作废：软删除后的发布。 - 删除：彻底删除后的发布。 | | status | String | **参数解释：** 发布/迭代的状态，枚举类型。 **取值范围：** - planned：发布/计划未开始 - going：发布/计划进行中 - ended：发布/计划已结束 | | 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 | **参数解释：** 基线状态，枚举类型，标识计划是否已纳入基线管理。 **取值范围：** - baselined：已基线 - unbaseline：未基线 - ""：未基线 | | workload | String | **参数解释：** 预估工作量，用于标识计划所需的人力或时间投入，单位人/天。 **取值范围：** 最大长度11个字符。 | | owner | String | **参数解释：** 责任人ID，标识计划的负责人。 **取值范围：** 长度为32位的字符串。 | 表6page | 参数 | 参数类型 | 描述 | |:---|:---|:---| | page | Integer | **参数解释：** 页码 **取值范围：** 不涉及 | | size | Integer | **参数解释：** 分页数量 **取值范围：** 不涉及 | | count | Integer | **参数解释：** 当前页数量 **取值范围：** 不涉及 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询发布/迭代计划列表成功 | | 400 | 错误信息 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-projectman/ErrorCode.html)。