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

Querying the Snapshot List

Function

This API is used to query the snapshot list.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

snapshots

Array of Snapshots objects

Definition

List of snapshot objects.

Range

N/A

count

Integer

Definition

Total number of records in the list.

Range

N/A
Table 3 Snapshots

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

finished

String

Definition

Time when a snapshot is complete. Format: 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

  • FROZEN

  • POLICE_FROZEN

type

String

Definition:

Snapshot type.

Range:

  • AUTO: automatic.

  • MANUAL: manual.

cluster_id

String

Definition

ID of the cluster for which the snapshot is created.

Range

N/A

datastore

Datastore object

Definition:

Database version.

Range:

None

cluster_name

String

Definition:

Cluster name.

Range:

None

updated

String

Definition:

Update time

Range:

None

bak_expected_start_time

String

Definition:

Time when snapshot creation is expected to start

Range:

None

bak_keep_day

Integer

Definition:

Retention days

Range:

None

bak_period

String

Definition:

Backup period

Range:

None

db_user

String

Definition:

Database username

Range:

None

progress

String

Definition:

Progress

Range:

None

backup_key

String

Definition:

Key generated during backup

Range:

None

prior_backup_key

String

Definition

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

Range

N/A

base_backup_key

String

Definition

Backup key of the full snapshot.

Range

N/A

backup_device

String

Definition:

Backup media.

Range:

None

total_backup_size

Long

Definition:

Total size of backup files

Range:

None

base_backup_name

String

Definition:

Name of a full snapshot

Range:

None

support_inplace_restore

Boolean

Definition:

Whether data can be backed up to the current cluster

Range:

None

fine_grained_backup

Boolean

Definition:

Whether fine-grained backup is supported

Range:

None

backup_level

String

Definition:

Backup level.

Range:

None

fine_grained_backup_detail

ExtFineGrainedSnapshotDetail object

Definition:

Fine-grained backup details

Range:

None

guest_agent_version

String

Definition:

Agent version

Range:

None

cluster_status

String

Definition:

Cluster status

Range:

None

cluster_task_status

String

Definition:

Cluster task status

Range:

None

support_fine_grained_cross_version_restore

Boolean

Definition:

Whether fine-grained cross-version restoration is supported

Range:

None

support_fine_grained_asymmetric_restore

Boolean

Definition:

Whether fine-grained heterogeneous restoration is supported

Range:

None
Table 4 Datastore

Parameter

Type

Description

type

String

Definition:

Cluster type

Range:

  • dws: DWS storage-compute integration.

  • dws3.0: DWS storage-compute decoupling.

  • hybrid: DWS real-time data warehouse.

version

String

Definition

Cluster version.

Range

N/A
Table 5 ExtFineGrainedSnapshotDetail

Parameter

Type

Description

database

String

Definition:

Database name

Range:

None

schema_list

Array of strings

Definition:

Database schema list

Range:

None

table_list

Array of strings

Definition:

Database table list

Range:

None

Example Requests

Query the snapshot list.

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots

Example Responses

Status code: 200

{
  "snapshots" : [ {
    "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
    "name" : "snapshot-1",
    "description" : "",
    "started" : "2016-08-23T03:59:23Z",
    "finished" : "2016-08-23T04:01:40Z",
    "size" : 500,
    "status" : "AVAILABLE",
    "type" : "MANUAL",
    "cluster_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c",
    "datastore" : {
      "type" : "dws",
      "version" : "8.2.1"
    },
    "cluster_name" : "dwstest-813-320",
    "updated" : "2016-08-23T04:01:23Z",
    "bak_expected_start_time" : "1471895963000",
    "bak_keep_day" : 7,
    "bak_period" : "0 0 2/8 ? * 2,3,4,5,6",
    "db_user" : "dbadmin",
    "progress" : "0",
    "backup_key" : "backup20160823_035927",
    "prior_backup_key" : "FULL",
    "base_backup_key" : "backup20160823_035927",
    "backup_device" : "obs",
    "total_backup_size" : 21759308,
    "base_backup_name" : "manual-snapshot",
    "support_inplace_restore" : true,
    "fine_grained_backup" : true,
    "backup_level" : "cluster",
    "fine_grained_backup_detail" : {
      "database" : "postgres",
      "schema_list" : [ "public", "test" ],
      "table_list" : [ "t1", "t2", "t3" ]
    },
    "guest_agent_version" : "8.2.1.300",
    "cluster_status" : "AVAILABLE",
    "cluster_task_status" : null,
    "support_fine_grained_cross_version_restore" : true,
    "support_fine_grained_asymmetric_restore" : true
  } ],
  "count" : 1
}

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