Help Center/ Data Warehouse Service/ API Reference/ API Description/ Snapshot Management/ Querying the Cluster Snapshot List
Updated on 2025-08-06 GMT+08:00
View PDF

Querying the Cluster Snapshot List

Function

This API is used to query the cluster snapshot list.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

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

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition

Size of a single page.

Constraints

N/A

Range

Greater than 0

Default Value

No limit.

offset

No

Integer

Definition

Page offset, which starts from 0 (page number minus 1).

Constraints

N/A

Range

Greater than or equal to 0

Default Value

0

sort_key

No

String

Definition

Sorting field.

Constraints

N/A

Range

N/A

Default Value

N/A

sort_dir

No

String

Definition

Sorting rule.

Constraints

N/A

Range

asc

desc

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

snapshots

Array of ClusterSnapshots objects

Definition

List of snapshot objects.

Range

N/A

project_id

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

String

Definition

Cluster ID.

Range

It is a 36-digit UUID.

count

Integer

Definition

Total number of snapshot objects.

Range

N/A
Table 4 ClusterSnapshots

Parameter

Type

Description

id

String

Definition

Snapshot ID.

Range

N/A

name

String

Definition

Snapshot name.

Range

N/A

description

String

Definition

Snapshot description.

Range

N/A

started

String

Definition

Snapshot creation time. The format is ISO8601: YYYY-MM-DDThh:mm:ssZ.

Range

N/A

size

Double

Definition

Snapshot size, in GB.

Range

N/A

status

String

Definition

Snapshot status.

Range

CREATING

AVAILABLE

UNAVAILABLE

RESTORING

FROZEN

POLICE_FROZEN

cluster_id

String

Definition

ID of the cluster for which the snapshot is created.

Range

N/A

datastore

Datastore object

Definition

Snapshot version.

Range

N/A

cluster_name

String

Definition

Name of the cluster for which the snapshot is created.

Range

N/A

updated

String

Definition

The time when the snapshot was updated.

Range

N/A

type

String

Definition

Snapshot type.

Range

MANUAL: manual snapshot.

AUTO: automatic snapshot.

bak_expected_start_time

String

Definition

Estimated start time of a snapshot.

Range

N/A

bak_keep_day

Integer

Definition

Retention days for a snapshot.

Range

N/A

bak_period

String

Definition

Snapshot policy.

Range

N/A

db_user

String

Definition

Database user.

Range

N/A

progress

String

Definition

Snapshot progress.

Range

N/A

backup_key

String

Definition

Snapshot backup key.

Range

N/A

prior_backup_key

String

Definition

Backup key of the previous snapshot used by the incremental backup.

Range

N/A

base_backup_key

String

Definition

Key of the full snapshot backup.

Range

N/A

backup_device

String

Definition

Backup media.

Range

N/A

total_backup_size

Integer

Definition

Total size of snapshots.

Range

N/A

base_backup_name

String

Definition

Name of the full snapshot.

Range

N/A

support_inplace_restore

Boolean

Definition

Whether in-place restoration is supported.

Range

N/A

fine_grained_backup

Boolean

Definition

Whether fine-grained backup is used.

Range

N/A

backup_level

String

Definition

Backup level.

Range

N/A

fine_grained_backup_detail

FineGrainedSnapshotDetail object

Definition

Fine-grained backup information.

Range

N/A

guest_agent_version

String

Definition

GuestAgent version.

Range

N/A

cluster_status

String

Definition

Cluster status.

Range

N/A
Table 5 Datastore

Parameter

Type

Description

type

String

Definition

Cluster type.

Range

N/A

version

String

Definition

Cluster version.

Range

N/A
Table 6 FineGrainedSnapshotDetail

Parameter

Type

Description

database

String

Definition

Database.

Range

N/A

schema_list

Array of strings

Definition

Schema list.

Range

N/A

table_list

Array of strings

Definition

Table set.

Range

N/A

Example Requests

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

Example Responses

Status code: 200

Snapshot list queried.

{
  "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
}

Status Codes

Status Code

Description

200

Snapshot list queried.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.
Parent Topic: Snapshot Management