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

查询集群快照列表

功能介绍

该接口用于查询集群快照列表。

调用方法

请参见如何调用API

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

cluster_id

String

参数解释

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

约束限制

必须是有效的dws集群ID。

取值范围

36位UUID。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

分页单页大小。

约束限制

不涉及。

取值范围

大于0。

默认取值

不限制。

offset

Integer

参数解释

分页偏移量,从0开始,页数减1。

约束限制

不涉及。

取值范围

大于等于0。

默认取值

0

sort_key

String

参数解释

排序字段。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

sort_dir

String

参数解释

排序规则。

约束限制

不涉及。

取值范围

asc:升序。

desc:降序。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

snapshots

Array of ClusterSnapshots objects

参数解释

快照对象列表。

取值范围

不涉及。

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

cluster_id

String

参数解释

集群ID。

取值范围

36位UUID。

count

Integer

参数解释

快照对象列表总数。

取值范围

不涉及。

表4 ClusterSnapshots

参数

参数类型

描述

id

String

参数解释

快照ID。

取值范围

不涉及。

name

String

参数解释

快照名称。

取值范围

不涉及。

description

String

参数解释

快照描述。

取值范围

不涉及。

started

String

参数解释

快照创建的日期时间,格式为 ISO8601: YYYY-MM-DDThh:mm:ssZ。

取值范围

不涉及。

size

Double

参数解释

快照大小,单位 GB。

取值范围

不涉及。

status

String

参数解释

快照状态。

取值范围

CREATING:创建中。

AVAILABLE:可用。

UNAVAILABLE:不可用。

RESTORING:恢复中。

FROZEN: 普通冻结。

POLICE_FROZEN: 公安冻结。

cluster_id

String

参数解释

快照对应的集群ID。

取值范围

不涉及。

datastore

Datastore object

参数解释

快照版本。

取值范围

不涉及。

cluster_name

String

参数解释

快照对应的集群名称。

取值范围

不涉及。

updated

String

参数解释

快照更新时间。

取值范围

不涉及。

type

String

参数解释

快照类型。

取值范围

MANUAL:手动快照。

AUTO:自动快照。

bak_expected_start_time

String

参数解释

快照预计开始时间。

取值范围

不涉及。

bak_keep_day

Integer

参数解释

快照保留天数。

取值范围

不涉及。

bak_period

String

参数解释

快照策略。

取值范围

不涉及。

db_user

String

参数解释

数据库用户。

取值范围

不涉及。

progress

String

参数解释

快照进度。

取值范围

不涉及。

backup_key

String

参数解释

快照备份key。

取值范围

不涉及。

prior_backup_key

String

参数解释

增量快照,使用的前一个快照备份key。

取值范围

不涉及。

base_backup_key

String

参数解释

对应全量快照备份key。

取值范围

不涉及。

backup_device

String

参数解释

备份介质。

取值范围

不涉及。

total_backup_size

Integer

参数解释

累计快照大小。

取值范围

不涉及。

base_backup_name

String

参数解释

对应全量快照名称。

取值范围

不涉及。

support_inplace_restore

Boolean

参数解释

是否支持就地恢复。

取值范围

不涉及。

fine_grained_backup

Boolean

参数解释

是否是细粒度备份。

取值范围

不涉及。

backup_level

String

参数解释

备份级别。

取值范围

不涉及。

fine_grained_backup_detail

FineGrainedSnapshotDetail object

参数解释

细粒度备份信息。

取值范围

不涉及。

guest_agent_version

String

参数解释

guestAgent版本。

取值范围

不涉及。

cluster_status

String

参数解释

集群状态。

取值范围

不涉及。

表5 Datastore

参数

参数类型

描述

type

String

参数解释

集群类型。

取值范围

不涉及。

version

String

参数解释

集群版本。

取值范围

不涉及。

表6 FineGrainedSnapshotDetail

参数

参数类型

描述

database

String

参数解释

数据库。

取值范围

不涉及。

schema_list

Array of strings

参数解释

模式列表。

取值范围

不涉及。

table_list

Array of strings

参数解释

表集合。

取值范围

不涉及。

请求示例

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/snapshots

响应示例

状态码:200

查询快照列表成功。

{
  "project_id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
  "cluster_id" : "e59d6b86-9072-46eb-a996-13f8b44994c1",
  "snapshots" : [ {
    "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
    "name" : "snapshot-1",
    "description" : "",
    "size" : 500,
    "status" : "AVAILABLE",
    "type" : "MANUAL",
    "backup_device" : "obs",
    "backup_key" : "20221027_041552",
    "bak_expected_start_time" : "1666843740000",
    "bak_keep_day" : 3,
    "bak_period" : "0 9 4/8 ? * 2,3,4,5,6,7",
    "base_backup_key" : "20221025_201556",
    "base_backup_name" : "dws-test-20221025201427",
    "cluster_id" : "e59d6b86-9072-46eb-a996-13f8b44994c1",
    "cluster_name" : "test_1025_02",
    "datastore" : {
      "type" : "dws",
      "version" : "8.2.0"
    },
    "db_user" : "dbadmin",
    "fine_grained_backup" : false,
    "guest_agent_version" : "8.2.0",
    "prior_backup_key" : "20221026_201555",
    "support_inplace_restore" : true,
    "total_backup_size" : 813475,
    "updated" : "2022-10-27T04:18:57"
  } ],
  "count" : 2
}

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 ListClusterSnapshotsSolution {

    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();
        ListClusterSnapshotsRequest request = new ListClusterSnapshotsRequest();
        request.withClusterId("{cluster_id}");
        try {
            ListClusterSnapshotsResponse response = client.listClusterSnapshots(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 = ListClusterSnapshotsRequest()
        request.cluster_id = "{cluster_id}"
        response = client.list_cluster_snapshots(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.ListClusterSnapshotsRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ListClusterSnapshots(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询快照列表成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。