文档首页/ 云搜索服务 CSS/ API参考（联盟区域）/ API V1/ 快照管理/ 查询快照列表
更新时间：2026-01-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询快照列表

功能介绍

该接口用于查询集群的所有快照信息，包括快照创建时间、数据引擎、快照ID、快照状态等，帮助客户全面掌控集群快照的生命周期管理。通过该接口，用户可快速定位指定快照的详细信息，验证快照可用性，辅助进行数据恢复、版本回滚或存储成本分析，同时为运维团队提供自动化监控和告警所需的结构化数据支撑，显著提升集群运维效率与稳定性。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID和名称。

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及

cluster_id

是

String

参数解释：

指定需查询快照列表的集群ID。获取方法请参见获取集群ID。

约束限制：

不涉及

取值范围：

集群ID。

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

backups

Array of ListSnapshotBackupsResp objects

参数解释：

快照列表。

取值范围：

不涉及
表3 ListSnapshotBackupsResp

参数

参数类型

描述

created

String

参数解释：

快照创建时间。

取值范围：

格式为ISO8601：CCYY-MM-DDThh:mm:ss。

datastore

ListSnapshotBackupsDatastoreResp object

参数解释：

集群引擎类型。

取值范围：

不涉及

description

String

参数解释：

快照描述信息。

取值范围：

不涉及

id

String

参数解释：

快照ID。

取值范围：

不涉及

clusterId

String

参数解释：

集群ID。

取值范围：

不涉及

clusterName

String

参数解释：

集群名字。

取值范围：

不涉及

name

String

参数解释：

快照名称。

取值范围：

不涉及

status

String

参数解释：

快照状态。

取值范围：

  • BUILDING：创建中。

  • COMPLETED：可用。

  • FAILED：不可用。

  • PART_FAILED：部分可用。

backupType

String

参数解释：

快照创建类型。

取值范围：

  • 0：表示自动创建。

  • 1：表示手动创建。

backupMethod

String

参数解释：

创建快照方式。

取值范围：

  • auto：表示自动创建。

  • manual：表示手动创建。

backupFrequency

String

参数解释：

集群快照频率。

取值范围：

  • HOUR：小时。

  • DAY：天。

  • HOUR：表示小时。
  • MON：表示周一。
  • TUE：表示周二。
  • WED：表示周三。
  • THU：表示周四。
  • FRI：表示周五。
  • SAT：表示周六。
  • SUN：表示周日。

indices

String

参数解释：

索引信息。

取值范围：

不涉及

totalShards

Integer

参数解释：

索引的总分片数。

取值范围：

不涉及

failedShards

Integer

参数解释：

备份失败的分片数。

取值范围：

不涉及

restoreStatus

String

参数解释：

快照恢复的状态。

取值范围：

  • restoring：恢复中。

  • success：恢复成功。

  • failed：恢复失败。

startTime

Long

参数解释：

快照开始执行的时间戳。

取值范围：

不涉及

endTime

Long

参数解释：

快照执行结束的时间戳。

取值范围：

不涉及

bucketName

String

参数解释：

保存快照数据的OBS桶名。

取值范围：

不涉及
表4 ListSnapshotBackupsDatastoreResp

参数

参数类型

描述

type

String

参数解释：

集群引擎类型。

取值范围：

  • elasticsearch：Elasticsearch集群。

  • openSearch：OpenSearch集群。

version

String

参数解释：

Elasticsearch引擎版本号。详细请参考CSS使用前必读中支持的版本。

取值范围：

不涉及

请求示例

查询集群的快照列表。

GET https://{Endpoint}/v1.0/{project_id}/clusters/37cb1075-c38e-4cd8-81df-442d52df3786/index_snapshots

响应示例

状态码：200

请求已成功。

{
  "backups" : [ {
    "created" : "2018-03-07T07:34:47",
    "datastore" : {
      "type" : "elasticsearch",
      "version" : "x.x.x"
    },
    "description" : "",
    "id" : "e29d99c1-3d19-4ea4-ae8d-f252df76cbe9",
    "clusterId" : "37cb1075-c38e-4cd8-81df-442d52df3786",
    "clusterName" : "Es-xfx",
    "name" : "snapshot-002",
    "status" : "COMPLETED",
    "updated" : "2018-03-07T07:40:12",
    "backupType" : "1",
    "backupMethod" : "manual",
    "backupFrequency" : "HOUR",
    "indices" : ".kibanawebsite2",
    "totalShards" : 6,
    "failedShards" : 0,
    "version" : "x.x.x",
    "restoreStatus" : "success",
    "startTime" : 1520408087099,
    "endTime" : 1520408412219,
    "bucketName" : "obs-b8ed"
  }, {
    "created" : "2018-03-06T15:42:37",
    "datastore" : {
      "type" : "elasticsearch",
      "version" : "x.x.x"
    },
    "description" : "",
    "id" : "29a2254e-947f-4463-b65a-5f0b17515fae",
    "clusterId" : "37cb1075-c38e-4cd8-81df-442d52df3786",
    "clusterName" : "Es-xfx",
    "name" : "snapshot-001",
    "status" : "COMPLETED",
    "updated" : "2018-03-06T15:48:04",
    "backupType" : "1",
    "backupMethod" : "manual",
    "indices" : ".kibana",
    "totalShards" : 1,
    "failedShards" : 0,
    "version" : "x.x.x",
    "restoreStatus" : "none",
    "startTime" : 1520350957275,
    "endTime" : 1520351284357,
    "bucketName" : "obs-b8ed"
  } ]
}

状态码

状态码

描述

200

请求已成功。

406

服务器无法根据客户端请求的内容特性完成请求。

错误码

请参见错误码。

父主题： 快照管理