文档首页/ 云硬盘 EVS/ API参考/ API/ 标准快照管理/ 查询自动快照策略 - ListAutoSnapshotPolicy
更新时间:2026-11-10 GMT+08:00
分享

查询自动快照策略 - ListAutoSnapshotPolicy

功能介绍

查询自动快照策略。标准快照当前只在部分区域支持,具体的区域列表请通过控制台查询。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    evs:snapshotPolicy:list

    List

    -

    g:EnterpriseProjectId

    -

    -

URI

GET /v5/{project_id}/snapshot-policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

自动快照策略ID。

name

否

String

自动快照策略名称。

tags

否

String

自动快照策略的标签的key/value对,例如[{"key1":"value1"}]。

tag_key

否

String

自动快照策略的标签的key。

enterprise_project_id

否

String

自动快照策略的企业项目ID。

limit

否

Integer

返回结果个数限制。

offset

否

Integer

偏移量。

sort_key

否

String

返回结果按该关键字排序,支持id,created_at等关键字,默认为“created_at”。

sort_dir

否

String

返回结果按照降序或升序排列,默认为“desc”。 降序:desc 升序:asc

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释

用户Token。

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

snapshot_policies

Array of GetSnapshotPolicy objects

查询的自动快照策略列表信息。

表5 GetSnapshotPolicy

参数

参数类型

描述

id

String

自动快照策略ID。

name

String

自动快照策略名称。最大支持255个字节。

最小长度:0

最大长度:255

repeat_weekdays

Array of strings

自动快照的重复日期,单位为天,周期为星期。取值范围为 1~7,如 1 表示周一。

当一星期内需要创建多次自动快照时,可以传入多个时间点:

最多传入 7 个时间点。

多个时间点用一个格式类似"1", "2", … "7"的 JSON 数组表示,时间点之间用半角逗号(,)隔开。

repeat_interval_days

Integer

自动快照的间隔日期,单位为天,取值范围为 1~30,如1表示每天。

time_points

Array of strings

自动快照的创建时间点。使用 UTC +8 时间,单位为小时。取值范围为 0~23,代表 00:00 至 23:00 共 24 个时间点,如 1 表示 01:00。

当一天内需要创建多次自动快照时,可以传入多个时间点:

最多传入 24 个时间点。

多个时间点用一个格式类似"0", "1", … "23"的 JSON 数组表示,时间点之间用半角逗号(,)隔开。

retention_days

Integer

设置快照的保留时间,单位为天。保留时间到期后快照会被自动释放,取值范围:1~65536。 缺省值:-1,表示快照持续保留。

created_at

String

自动快照策略的创建时间。

updated_at

String

自动快照策略的更新时间。

tags

Map<String,String>

设置自动快照策略的标签。

enterprise_project_id

String

企业项目id。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error

Error object

参数解释

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

取值范围

不涉及。

表7 Error

参数

参数类型

描述

code

String

参数解释

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

取值范围

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

message

String

参数解释

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

取值范围

不涉及。

请求示例

无

响应示例

状态码:200

无

状态码: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
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 ListAutoSnapshotPolicySolution {

    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();
        ListAutoSnapshotPolicyRequest request = new ListAutoSnapshotPolicyRequest();
        try {
            ListAutoSnapshotPolicyResponse response = client.listAutoSnapshotPolicy(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
# 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 = ListAutoSnapshotPolicyRequest()
        response = client.list_auto_snapshot_policy(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
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.ListAutoSnapshotPolicyRequest{}
	response, err := client.ListAutoSnapshotPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

相关文档