更新时间:2025-07-23 GMT+08:00
分享

查询快照策略

功能介绍

查询快照策略。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/clusters/{cluster_id}/snapshot-policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

cluster_id

String

参数解释

集群ID。获取方法请参见获取集群ID

约束限制

必须是有效的dws集群ID。

取值范围

36位UUID。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

keep_day

Integer

参数解释

保留天数。

取值范围

大于等于0。

backup_strategies

Array of BackupStrategyDetail objects

参数解释

备份策略列表。

取值范围

不涉及。

device_name

String

参数解释

备份设备,一般为OBS。

取值范围

不涉及。

server_ips

Array of strings

参数解释

服务IP。

取值范围

不涉及。

server_port

String

参数解释

服务端口。

取值范围

不涉及。

backup_param

String

参数解释

备份参数。

取值范围

不涉及。

auto_backup

Boolean

参数解释

自动备份开关状态。

取值范围

true:已开启自动备份选项;

false:已关闭自动备份选项;

backup_strategy_cluster_type_limit_num

Integer

参数解释

此策略下集群级快照最大数量。

取值范围

大于等于0。

backup_strategy_schema_type_limit_num

Integer

参数解释

此策略下schema级快照最大数量。

取值范围

大于等于0。

表3 BackupStrategyDetail

参数

参数类型

描述

policy_id

String

参数解释

策略ID。

取值范围

不涉及。

policy_name

String

参数解释

策略名称。

取值范围

不涉及。

backup_strategy

String

参数解释

执行策略,一般为crontab表达式。

取值范围

不涉及。

backup_type

String

参数解释

备份类型。

取值范围

不涉及。

backup_level

String

参数解释

备份级别。

取值范围

不涉及。

next_fire_time

String

参数解释

下次触发时间(预估,与其它任务冲突时不执行)。

取值范围

不涉及。

update_time

String

参数解释

更新时间。

取值范围

不涉及。

time_zone_offset

Integer

参数解释

时区偏移量(相比UTC时间)。

取值范围

0~23

请求示例

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/snapshot-policies

响应示例

状态码:200

查询快照策略成功。

{
  "keep_day" : 3,
  "backup_strategies" : [ {
    "policy_id" : "3b5464ad-74a5-42cc-9667-76122839109a",
    "policy_name" : "apie-default-full-strategy",
    "backup_strategy" : "0 0 2 ? * 1",
    "backup_type" : "full",
    "backup_level" : "cluster",
    "next_fire_time" : "1747533600000",
    "update_time" : "2025-05-11T10:06:16",
    "time_zone_offset" : 0
  }, {
    "policy_id" : "ceaeaf07-d600-494c-86d7-caa0fbf0858a",
    "policy_name" : "apie-default-increment-strategy",
    "backup_strategy" : "0 7 2/8 ? * 2,3,4,5,6,7",
    "backup_type" : "increment",
    "backup_level" : "cluster",
    "next_fire_time" : "1747015620000",
    "update_time" : "2025-05-11T10:06:16",
    "time_zone_offset" : 0
  } ],
  "device_name" : "OBS",
  "server_ips" : null,
  "server_port" : null,
  "backup_param" : null,
  "auto_backup" : true,
  "backup_strategy_cluster_type_limit_num" : 10,
  "backup_strategy_schema_type_limit_num" : 50
}

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


public class ListSnapshotPolicySolution {

    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);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListSnapshotPolicyRequest request = new ListSnapshotPolicyRequest();
        request.withClusterId("{cluster_id}");
        try {
            ListSnapshotPolicyResponse response = client.listSnapshotPolicy(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.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 = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListSnapshotPolicyRequest()
        request.cluster_id = "{cluster_id}"
        response = client.list_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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListSnapshotPolicyRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ListSnapshotPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询快照策略成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。

相关文档