批量删除计划 - BatchDeletePlans
功能介绍
当需要删除发布计划/迭代时,可调用此接口,用户可以根据传入的发布计划/迭代ID列表批量删除计划或迭代。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
DELETE /v1/planservice/projects/{project_id}/plans/batch-delete
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32个字符,由英文字母和数字组成。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| x-auth-token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为10-32768的字符串。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ids | 是 | Array of strings | 参数解释: 批量删除的发布计划/迭代的ID列表。通过发布/迭代计划列表查询接口获取,响应消息体中的id字段的值就是发布/迭代ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 返回状态。 取值范围: |
| message | String | 参数解释: 返回消息。 取值范围: 不涉及。 |
| result | BatchResultVO object | 参数解释: 批量操作结果数据。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| success_num | Number | 参数解释: 批量操作成功的数量。 取值范围: 不涉及。 |
| fail_num | Number | 参数解释: 批量操作失败的数量。 取值范围: 不涉及。 |
| success | Array of BatchOperateInfo objects | 参数解释: 批量操作成功的计划列表。 |
| failed | Array of BatchOperateInfo objects | 参数解释: 批量操作失败的计划列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 发布/迭代计划ID。 取值范围: 长度为18~19个字符的数字字符串。 |
| modified_by | String | 参数解释: 最近更新人ID。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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" : [ ]
}
} 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 48 49 50 51 52 53 54 | 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.*; import java.util.List; import java.util.ArrayList; public class BatchDeletePlansSolution { 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(); BatchDeletePlansRequest request = new BatchDeletePlansRequest(); request.withProjectId("{project_id}"); BatchOperateReqVO body = new BatchOperateReqVO(); List<String> listbodyIds = new ArrayList<>(); listbodyIds.add("1164155086611324928"); listbodyIds.add("1164155134381436929"); body.withIds(listbodyIds); request.withBody(body); try { BatchDeletePlansResponse response = client.batchDeletePlans(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 33 34 35 36 37 38 | # 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 = BatchDeletePlansRequest() request.project_id = "{project_id}" listIdsbody = [ "1164155086611324928", "1164155134381436929" ] request.body = BatchOperateReqVO( ids=listIdsbody ) response = client.batch_delete_plans(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 49 50 51 52 53 54 55 | 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.BatchDeletePlansRequest{} request.ProjectId = "{project_id}" var listIdsbody = []string{ "1164155086611324928", "1164155134381436929", } request.Body = &model.BatchOperateReqVo{ Ids: listIdsbody, } response, err := client.BatchDeletePlans(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 批量删除接口成功的响应 |
| 400 | 批量删除接口失败的错误信息 |
错误码
请参见错误码。