# 批量删除计划 - BatchDeletePlans #### 功能介绍 当需要删除发布计划/迭代时，可调用此接口，用户可以根据传入的发布计划/迭代ID列表批量删除计划或迭代。 #### 调用方法 请参见[如何调用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:delete | Write | - | - codeartsreq:Model - codeartsreq:ProjectId | - | - | #### URI DELETE /v1/planservice/projects/{project_id}/plans/batch-delete 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目的32位uuid，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取，响应消息体中的**project_id**字段的值就是项目ID。 **约束限制**： 32个字符，由英文字母和数字组成。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | x-auth-token | 是 | String | **参数解释**： 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及。 **取值范围**： 长度为10-32768的字符串。 **默认取值**： 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ids | 是 | Array of strings | **参数解释**： 批量删除的发布计划/迭代的ID列表。通过[发布/迭代计划列表查询](https://support.huaweicloud.com/api-projectman/ListPlan.html)接口获取，响应消息体中的**id**字段的值就是发布/迭代ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**： 返回状态。 **取值范围**： - success：批量操作成功 - error：批量操作失败 | | message | String | **参数解释**： 返回消息。 **取值范围**： 不涉及。 | | result | [BatchResultVO] object | **参数解释**： 批量操作结果数据。 | 表5BatchResultVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | success_num | Number | **参数解释**： 批量操作成功的数量。 **取值范围**： 不涉及。 | | fail_num | Number | **参数解释**： 批量操作失败的数量。 **取值范围**： 不涉及。 | | success | Array of [BatchOperateInfo] objects | **参数解释**： 批量操作成功的计划列表。 | | failed | Array of [BatchOperateInfo] objects | **参数解释**： 批量操作失败的计划列表。 | 表6BatchOperateInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 发布/迭代计划ID。 **取值范围**： 长度为18\~19个字符的数字字符串。 | | modified_by | String | **参数解释**： 最近更新人ID。 **取值范围**： 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误描述信息。 **取值范围**： 不涉及。 | #### 请求示例 批量删除计划 ``` DELETE https://{endpoint}/v1/planservice/projects/9548acc581ba498d9895ecdb7d2db5ea/plans/batch-delete { "ids" : [ "1164155086611324928", "1164155134381436929" ] } ``` #### 响应示例 **状态码：200** ``` { "status" : "success", "message" : null, "result" : { "success_num" : 2, "fail_num" : 0, "success" : [ { "id" : "1164155086611324928", "modified_by" : "a360371833bf4c558f796fd707b44daf" }, { "id" : "1164155134381436929", "modified_by" : "a360371833bf4c558f796fd707b44daf" } ], "failed" : [ ] } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 批量删除接口成功的响应 | | 400 | 批量删除接口失败的错误信息 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-projectman/ErrorCode.html)。