文档首页/ 数据仓库服务 DWS/ 更多文档/ API参考（联盟区域）/ API说明/ 快照管理/ 查询快照列表
更新时间：2025-12-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询快照列表

功能介绍

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

调用方法

请参见如何调用API。

URI

GET /v1.0/{project_id}/snapshots

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

snapshots

Array of Snapshots objects

参数解释：

快照对象列表。

取值范围：

不涉及。

count

Integer

参数解释：

列表总数。

取值范围：

不涉及。
表3 Snapshots

参数

参数类型

描述

id

String

参数解释：

快照ID。

取值范围：

不涉及。

name

String

参数解释：

快照名称。

取值范围：

不涉及。

description

String

参数解释：

快照描述。

取值范围：

不涉及。

started

String

参数解释：

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

取值范围：

不涉及。

finished

String

参数解释：

快照完成的日期时间，格式为 ISO8601: YYYY-MM-DDThh:mm:ssZ。

取值范围：

不涉及。

size

Double

参数解释：

快照大小，单位 GB。

取值范围：

不涉及。

status

String

参数解释：

快照状态。

取值范围：

  • CREATING：创建中。

  • AVAILABLE：可用。

  • UNAVAILABLE：不可用。

  • FROZEN： 普通冻结。

  • POLICE_FROZEN： 公安冻结。

type

String

参数解释：

快照创建类型。

取值范围：

不涉及。

cluster_id

String

参数解释：

快照对应的集群ID。

取值范围：

不涉及。

datastore

Datastore object

参数解释：

数据库版本。

取值范围：

不涉及。

cluster_name

String

参数解释：

集群名称。

取值范围：

不涉及。

updated

String

参数解释：

更新时间。

取值范围：

不涉及。

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

参数解释：

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

取值范围：

不涉及。

base_backup_key

String

参数解释：

对应全量快照的BackupKey。

取值范围：

不涉及。

backup_device

String

参数解释：

备份介质。

取值范围：

不涉及。

total_backup_size

Long

参数解释：

总备份文件大小。

取值范围：

不涉及。

base_backup_name

String

参数解释：

对应全量快照名称。

取值范围：

不涉及。

support_inplace_restore

Boolean

参数解释：

是否支持备份到当前集群。

取值范围：

不涉及。

fine_grained_backup

Boolean

参数解释：

是否支持细粒度备份。

取值范围：

不涉及。

backup_level

String

参数解释：

备份等级。

取值范围：

不涉及。

fine_grained_backup_detail

ExtFineGrainedSnapshotDetail object

参数解释：

细粒度备份详情。

取值范围：

不涉及。

guest_agent_version

String

参数解释：

agent版本。

取值范围：

不涉及。

cluster_status

String

参数解释：

集群状态。

取值范围：

不涉及。

cluster_task_status

String

参数解释：

集群任务状态。

取值范围：

不涉及。

support_fine_grained_cross_version_restore

Boolean

参数解释：

是否支持细粒度跨版本恢复。

取值范围：

不涉及。

support_fine_grained_asymmetric_restore

Boolean

参数解释：

是否支持细粒度异构恢复。

取值范围：

不涉及。
表4 Datastore

参数

参数类型

描述

type

String

参数解释：

集群类型。

取值范围：

不涉及。

version

String

参数解释：

集群版本。

取值范围：

不涉及。
表5 ExtFineGrainedSnapshotDetail

参数

参数类型

描述

database

String

参数解释：

数据库名称。

取值范围：

不涉及。

schema_list

Array of strings

参数解释：

数据库模式列表。

取值范围：

不涉及。

table_list

Array of strings

参数解释：

数据库表列表。

取值范围：

不涉及。

请求示例

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

响应示例

状态码：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" : "20160823_035923",
    "prior_backup_key" : "FULL",
    "base_backup_key" : "20160823_035923",
    "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
  }, {
    "id" : "4af11460-06ec-48a4-b3ad-0e3bbdcd8ab1",
    "name" : "snapshot-2",
    "description" : "",
    "started" : "2016-08-23T18:20:00Z",
    "finished" : "2016-08-23T18:22:12Z",
    "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" : "20160823_035923",
    "prior_backup_key" : "FULL",
    "base_backup_key" : "20160823_035923",
    "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" : 2
}

状态码

状态码

描述

200

查询快照列表成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。
父主题： 快照管理