更新时间:2024-06-19 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

表2 Query参数

参数

是否必选

参数类型

描述

sort_key

String

排序字段,排序字段需与排序规则一一对应。

可选字段:name、clusterName、startTime

sort_dir

String

排序规则:

  • ASC
  • DESC

offset

Integer

偏移量,从第几条开始查询。

limit

Integer

查询条数。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

snapshots

Array of Snapshots objects

快照对象列表。

count

Integer

快照对象列表总数

project_id

String

项目ID。

cluster_id

String

集群ID。

表4 Snapshots

参数

参数类型

描述

id

String

快照ID。

name

String

快照名称。

description

String

快照描述。

started

String

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

updated

String

快照记录更新时间,格式为 ISO8601: YYYY-MM-DDThh:mm:ssZ。

size

Double

快照大小,单位 GB。

status

String

快照状态:

  • CREATING:创建中。

  • AVAILABLE:可用。

  • UNAVAILABLE:不可用,备份失败。

  • RESTORING: 恢复中。

type

String

快照创建类型。其中:

  • MANUAL为手动快照。
  • AUTO为自动快照。

cluster_id

String

快照对应的集群ID。

cluster_name

String

快照对应的集群名称。

backup_key

String

备份产生的Key。

prior_backup_key

String

增量快照使用前一个快照的BakcupKey。当取值为FULL时表示这是一个全量快照。

base_backup_key

String

对应全量快照的BackupKey。

backup_device

String

备份介质。

total_backup_size

Long

快照累计大小,表示从全量开始到当前增量的累计大小。单位KB

base_backup_name

String

对应全量快照名称。

support_inplace_restore

Boolean

是否支持恢复至原集群。

fine_grained_backup

Boolean

是否是细粒度备份。

fine_grained_backup_detail

FineGrainedSnapshotDetail

object

细粒度备份信息。

guest_agent_version

String

集群guestAgent版本号。

cluster_status

String

集群状态

  • AVAILABLE:可用

  • UNAVAILABLE:不可用

  • FROZEN:已冻结

bak_expected_start_time

String

预计快照开始时间。

bak_keep_day

Integer

备份保留天数。

bak_period

String

集群策略。

db_user

String

备份用户。

datastore

DataStore object

数据库版本

progress

String

备份进度。

backup_level

String

备份级别

  • cluster
  • schema
表5 FineGrainedSnapshotDetail

参数

参数类型

描述

database

String

备份数据库。

schema_list

Array of String

备份模式集合。

table_list

Array of String

备份表集合。

表6 DataStore

参数

参数类型

描述

type

String

数据库类型。

version

String

数据库版本。

请求示例

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/snapshots?sort_key=name&sort_dir=desc&offset=10&limit=5

响应示例

状态码: 200

查询快照列表成功。

{
    "snapshots": [
        {
            "datastore": {
                "type": "dws",
                "version": "8.1.3.200"
            },
            "description": "",
            "id": "02413539-6556-434c-a795-a44e9db7262d",
            "cluster_id": "1446b166-b73f-4096-b9bd-9a30afe3071f",
            "cluster_name": "ysj-1101-0917",
            "name": "kz-001",
            "size": 206400,
            "status": "COMPLETED",
            "updated": "2022-11-01T02:15:26",
            "type":"AUTO",
            "backup_key": "20221101_021217",
            "prior_backup_key": "FULL",
            "base_backup_key": "20221101_021217",
            "backup_device": "OBS",
            "total_backup_size": 206400,
            "base_backup_name": "kz-001",
            "support_inplace_restore": true,
            "fine_grained_backup": false,
            "fine_grained_backup_detail": {},
            "guest_agent_version": "8.2.0.1",
            "cluster_status": "AVAILABLE",
            "bak_expected_start_time": "1667295060000",
            "bak_keep_day": 3,
            "bak_period": "0 31 1/8 ? * 2,3,4,5,6,7",
            "db_user": "dbadmin"
        }
    ],
    "project_id": "4cf650fd46704908aa071b4df2453e1e",
    "cluster_id": "1446b166-b73f-4096-b9bd-9a30afe3071f",
    "count": 1
}

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

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListClusterSnapshotsRequest request = new ListClusterSnapshotsRequest();
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withSortKey("<sort_key>");
        request.withSortDir("<sort_dir>");
        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
33
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListClusterSnapshotsRequest()
        request.limit = <limit>
        request.offset = <offset>
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        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
39
40
41
42
43
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

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

    request := &model.ListClusterSnapshotsRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	sortDirRequest:= "<sort_dir>"
	request.SortDir = &sortDirRequest
	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

服务不可用。

相关文档