Updated on 2024-04-18 GMT+08:00

Querying the Cluster Snapshot List

Function

This API is used to query the cluster snapshot list.

Call Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the ID, see Obtaining the Cluster ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

sort_key

No

String

Collation columns. Each collation column must correspond to a collation rule.

Optional columns: name, clusterName, and startTime

sort_dir

No

String

Collation rule

  • ASC
  • DESC

offset

No

Integer

Offset, which indicates the sequence number of the record from which the query starts.

limit

No

Integer

Number of records to be queried

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

snapshots

Array of Snapshots objects

List of snapshot objects

count

Integer

Total number of snapshot objects

project_id

String

Project ID

cluster_id

String

Cluster ID

Table 4 Snapshots

Parameter

Type

Description

id

String

Snapshot ID

name

String

Snapshot name

description

String

Snapshot description

started

String

Time when a snapshot starts to be created. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ

updated

String

Time when the snapshot record is updated. The format is ISO8601: YYYY-MM-DDThh:mm:ssZ.

size

Double

Snapshot size, in GB

status

String

Snapshot status:

  • CREATING

  • AVAILABLE

  • UNAVAILABLE

  • RESTORING

type

String

Snapshot type Where,

  • MANUAL indicates a manual snapshot.
  • AUTO indicates an automatic snapshot.

cluster_id

String

ID of the cluster for which the snapshot is created.

cluster_name

String

Name of the cluster for which the snapshot is created

backup_key

String

Key generated during backup

prior_backup_key

String

Backup key of the previous snapshot used by the incremental backup The value FULL indicates a full snapshot.

base_backup_key

String

Backup key of a full snapshot

backup_device

String

Backup media

total_backup_size

Long

Accumulated size of a snapshot, from the full backup to the incremental backup. Unit: KB

base_backup_name

String

Name of a full snapshot

support_inplace_restore

Boolean

Whether data can be restored to the original cluster

fine_grained_backup

Boolean

Whether the backup is a fine-grained backup

fine_grained_backup_detail

FineGrainedSnapshotDetail

object

Fine-grained backup information

guest_agent_version

String

GuestAgent version

cluster_status

String

Cluster status

  • AVAILABLE

  • UNAVAILABLE

  • FROZEN

bak_expected_start_time

String

Estimated snapshot start time

bak_keep_day

Integer

Backup retention days

bak_period

String

Cluster policy

db_user

String

Backup user

datastore

DataStore object

Database version

progress

String

Backup progress

backup_level

String

Backup level

  • cluster
  • schema
Table 5 FineGrainedSnapshotDetail

Parameter

Type

Description

database

String

Database backup

schema_list

Array of String

Backup schema set

table_list

Array of String

Backup table set

Table 6 DataStore

Parameter

Type

Description

type

String

Database type

version

String

Database version

Example Request

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

Example Response

Status code: 200

The snapshot list is queried successfully.

{
    "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 Sample Code

The sample code is as follows:

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

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

The snapshot list is queried successfully.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

The service was unavailable.