文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD工作项快照/ 批量更新快照可删除标识 - BatchUpdateSnapshotDeletableFlag
更新时间:2026-09-01 GMT+08:00
分享

批量更新快照可删除标识 - BatchUpdateSnapshotDeletableFlag

功能介绍

批量更新快照的可删除标识状态。

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsreq:workitem:update

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

PUT /v1/ipdprojectservice/projects/{project_id}/baseline-snapshots/deletions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目32位ID,项目唯一标识。通过查询IPD项目列表获取,响应消息体中的id字段的值就是项目ID。

约束限制

不涉及。

取值范围

32个字符,由英文字母和数字组成。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

ids

Array of strings

参数解释

快照ID列表。通过接口查询工作项计划管理快照列表获取响应参数中的id字段。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

deletable

Boolean

参数解释

是否为可删除标识。

约束限制

不涉及。

取值范围

  • true:可删除。

  • false:不可删除。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

message

String

参数解释

响应信息。

取值范围

不涉及。

code

String

参数解释

响应码。

取值范围

不涉及。

total_count

Integer

参数解释

总数量。

取值范围

不涉及。

success_count

Integer

参数解释

成功数量。

取值范围

不涉及。

failure_count

Integer

参数解释

失败数量。

取值范围

不涉及。

failure_details

Array of FailureDetail objects

参数解释

失败详情列表。

取值范围

不涉及。

表4 FailureDetail

参数

参数类型

描述

snapshot_id

String

参数解释

快照ID。

取值范围

不涉及。

snapshot_title

String

参数解释

快照标题。

取值范围

不涉及。

failure_reason

String

参数解释

失败原因。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述,对error_code的补充解释。

取值范围

不涉及。

请求示例

批量更新快照可删除标识。

PUT https://{endpoint}/v1/ipdprojectservice/projects/5d6e0b0e07e3464d94d62fddaa6e8652/baseline-snapshots/deletions

{
  "ids" : [ "1233499637803978753", "1233506751100293121" ],
  "deletable" : false
}

响应示例

状态码:200

参数解释

批量操作快照响应对象。

取值范围

不涉及。

{
  "message" : "success",
  "code" : "200",
  "total_count" : 2,
  "success_count" : 1,
  "failure_count" : 1,
  "failure_details" : [ {
    "snapshot_id" : "1240765858519490561",
    "snapshot_title" : "快照标题",
    "failure_reason" : "快照版本不存在",
    "error_code" : "PM.02176625"
  } ]
}

状态码:400

请求失败的响应。例如无操作权限、项目不存在。

{
  "error_code" : "PM.02174103",
  "error_msg" : "无操作权限"
}

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
55
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 BatchUpdateSnapshotDeletableFlagSolution {

    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();
        BatchUpdateSnapshotDeletableFlagRequest request = new BatchUpdateSnapshotDeletableFlagRequest();
        request.withProjectId("{project_id}");
        BatchUpdateSnapshotDeletableVO body = new BatchUpdateSnapshotDeletableVO();
        List<String> listbodyIds = new ArrayList<>();
        listbodyIds.add("1233499637803978753");
        listbodyIds.add("1233506751100293121");
        body.withDeletable(false);
        body.withIds(listbodyIds);
        request.withBody(body);
        try {
            BatchUpdateSnapshotDeletableFlagResponse response = client.batchUpdateSnapshotDeletableFlag(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
39
# 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 = BatchUpdateSnapshotDeletableFlagRequest()
        request.project_id = "{project_id}"
        listIdsbody = [
            "1233499637803978753",
            "1233506751100293121"
        ]
        request.body = BatchUpdateSnapshotDeletableVO(
            deletable=False,
            ids=listIdsbody
        )
        response = client.batch_update_snapshot_deletable_flag(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
56
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.BatchUpdateSnapshotDeletableFlagRequest{}
	request.ProjectId = "{project_id}"
	var listIdsbody = []string{
        "1233499637803978753",
	    "1233506751100293121",
    }
	request.Body = &model.BatchUpdateSnapshotDeletableVo{
		Deletable: false,
		Ids: listIdsbody,
	}
	response, err := client.BatchUpdateSnapshotDeletableFlag(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

参数解释

批量操作快照响应对象。

取值范围

不涉及。

400

请求失败的响应。例如无操作权限、项目不存在。

错误码

请参见错误码

相关文档