文档首页/ 数据仓库服务 DWS/ 更多文档/ API参考（吉隆坡区域）/ API说明/ 快照管理/ 查询快照列表
更新时间：2025-09-18 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。

取值范围：

不涉及。

请求示例

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"
  }, {
    "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"
  } ],
  "count" : 2
}

状态码

状态码

描述

200

查询快照列表成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

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