文档首页/ 云硬盘 EVS/ API参考/ API/ 标准快照管理/ 更新快照一致性组 - UpdateSnapshotGroup
更新时间:2026-11-10 GMT+08:00
分享

更新快照一致性组 - UpdateSnapshotGroup

功能介绍

更新快照一致性组。标准快照当前只在部分区域支持,具体的区域列表请通过控制台查询。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    evs:snapshotGroups:update

    Write

    snapshotGroup *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

URI

PUT /v5/{project_id}/snapshot-groups/{snapshot_group_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释

项目ID。获取方法请参见获取项目ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

snapshot_group_id

是

String

参数解释

快照一致性组ID。

可通过查询快照一致性组列表接口获取快照一致性组ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

snapshot_group

是

UpdateSnapshotGroupResponseBody object

参数解释

待更新的快照一致性组信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表4 UpdateSnapshotGroupResponseBody

参数

是否必选

参数类型

描述

name

否

String

参数解释

快照一致性组名称。

约束限制

最大支持255个字节。

取值范围

最小长度:0

最大长度:255

默认取值

不涉及。

description

否

String

参数解释

快照一致性组描述。

约束限制

最大支持255个字节。

取值范围

最小长度:0

最大长度:255

默认取值

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

snapshot_group

SnapshotGroupDetail object

参数解释

更新后的快照一致性组信息。

取值范围

不涉及。

表6 SnapshotGroupDetail

参数

参数类型

描述

id

String

参数解释

快照一致性组的ID。

取值范围

不涉及。

project_id

String

参数解释

快照一致性组的项目ID。

取值范围

不涉及。

created_at

String

参数解释

快照一致性组的创建时间。

取值范围

不涉及。

status

String

参数解释

快照一致性组的状态。

取值范围

  • creating:创建中。

  • available:创建成功。

  • error:创建失败。

  • deleting: 删除中。

  • deleted:删除成功。

  • error_deleting:删除失败。

updated_at

String

参数解释

快照一致性组的更新时间。

取值范围

不涉及。

name

String

参数解释

快照一致性组的名称。

取值范围

不涉及。

description

String

参数解释

快照一致性组的描述。

取值范围

不涉及。

enterprise_project_id

String

参数解释

快照一致性组的企业项目id。

取值范围

不涉及。

tags

Map<String,String>

参数解释

快照一致性组的标签。

标签的value:String类型,最大长度43个字符,可以为空字符串。

由英文字母、数字、下划线、点、中划线、UNICODE字符(\u4E00-\u9FFF)组成。

标签的value:String类型,最大长度43个字符,可以为空字符串。

由英文字母、数字、下划线、点、中划线、UNICODE字符(\u4E00-\u9FFF)组成。

取值范围

不涉及。

server_id

String

参数解释

云服务器id。

取值范围

不涉及。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error

Error object

参数解释

出现错误时,返回的错误信息。

取值范围

不涉及。

表8 Error

参数

参数类型

描述

code

String

参数解释

出现错误时,返回的错误码。

取值范围

错误码和其对应的含义请参考错误码说明。

message

String

参数解释

出现错误时,返回的错误消息。

取值范围

不涉及。

请求示例

PUT https://{endpoint}/v5/{project_id}/snapshot-groups/{snapshot_group_id}

{
  "snapshot_group" : {
    "name" : "snap-group-001",
    "description" : "test"
  }
}

响应示例

状态码:200

{
  "snapshot_group" : {
    "id" : "5e0fc839-9a2f-4d45-8ae5-a54859083673",
    "server_id" : null,
    "project_id" : "060576838600d5762f2dc000470eb164",
    "enterprise_project_id" : "0",
    "name" : "test_ssg_name",
    "description" : "test_ssg_description",
    "status" : "available",
    "tags" : {
      "this_is_test_key" : "this_is_test_value"
    },
    "created_at" : "2024-02-17T02:58:48.583012",
    "updated_at" : "2024-02-17T02:58:48.736012"
  }
}

状态码:400

{
  "error" : {
    "message" : "XXXX",
    "code" : "EVS.XXX"
  }
}

SDK代码示例

SDK代码示例如下。

 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.evs.v2.region.EvsRegion;
import com.huaweicloud.sdk.evs.v2.*;
import com.huaweicloud.sdk.evs.v2.model.*;


public class UpdateSnapshotGroupSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        EvsClient client = EvsClient.newBuilder()
                .withCredential(auth)
                .withRegion(EvsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateSnapshotGroupRequest request = new UpdateSnapshotGroupRequest();
        request.withSnapshotGroupId("{snapshot_group_id}");
        UpdateSnapshotGroupRequestBody body = new UpdateSnapshotGroupRequestBody();
        UpdateSnapshotGroupResponseBody snapshotGroupbody = new UpdateSnapshotGroupResponseBody();
        snapshotGroupbody.withName("snap-group-001")
            .withDescription("test");
        body.withSnapshotGroup(snapshotGroupbody);
        request.withBody(body);
        try {
            UpdateSnapshotGroupResponse response = client.updateSnapshotGroup(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());
        }
    }
}
 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 huaweicloudsdkevs.v2.region.evs_region import EvsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkevs.v2 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = EvsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EvsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateSnapshotGroupRequest()
        request.snapshot_group_id = "{snapshot_group_id}"
        snapshotGroupbody = UpdateSnapshotGroupResponseBody(
            name="snap-group-001",
            description="test"
        )
        request.body = UpdateSnapshotGroupRequestBody(
            snapshot_group=snapshotGroupbody
        )
        response = client.update_snapshot_group(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
57
58
59
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    evs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/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")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := evs.EvsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := evs.NewEvsClient(hcClient)

    request := &model.UpdateSnapshotGroupRequest{}
	request.SnapshotGroupId = "{snapshot_group_id}"
	nameSnapshotGroup:= "snap-group-001"
	descriptionSnapshotGroup:= "test"
	snapshotGroupbody := &model.UpdateSnapshotGroupResponseBody{
		Name: &nameSnapshotGroup,
		Description: &descriptionSnapshotGroup,
	}
	request.Body = &model.UpdateSnapshotGroupRequestBody{
		SnapshotGroup: snapshotGroupbody,
	}
	response, err := client.UpdateSnapshotGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

相关文档