帮你快速理解、总结文档立即下载
文档中心>Elasticsearch Service>API 文档>快照相关接口>获取集群快照列表概览

获取集群快照列表概览

最近更新时间：2026-07-15 02:00:42

我的收藏

本页目录：

1. 接口描述

接口请求域名： es.tencentcloudapi.com 。

获取集群快照列表概览

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSnapshotViews。
Version 是 String 公共参数，本接口取值：2018-04-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId.N 否 Array of String

集群实例ID


示例值：["es-ldmd4rpp"]
State.N 否 Array of String

快照状态，IN_PROGRESS,SUCCESS,FAILED,PARTIAL


示例值：["SUCCESS"]
UserBackUp 否 String

创建方式: true(手动备份); false(自动备份); 空字符串表示全部


示例值：false
Duration 否 Integer

时间范围, 最近多少天, 0表示查询所有时间范围


示例值：0

3. 输出参数

参数名称 类型 描述
Snapshots Array of Snapshots

快照信息


注意：此字段可能返回 null，表示取不到有效值。
FailedMsgs Array of String

集群快照获取失败信息


注意：此字段可能返回 null，表示取不到有效值。
示例值：["GetClusterSnapshotsByRepositoryList for instance es-3m9ftde7 failed: instance es-3m9ftde7 have no nodes"]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 demo

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSnapshotViews
<公共请求参数>

{
    "InstanceId": [
        "es-ldmd4rpp"
    ],
    "State": [
        "SUCCESS"
    ],
    "UserBackUp": "false",
    "Duration": 0
}

输出示例

{
    "Response": {
        "Snapshots": [
            {
                "AutoBackupInterval": 1,
                "CosEncryption": 0,
                "CosRetention": 0,
                "DataStreams": [
                    "ilm-history-5"
                ],
                "DurationInMillis": 42616,
                "EndTime": "2026-04-20T09:53:01.383Z",
                "EsRepositoryType": 0,
                "FailedShards": 0,
                "Failures": [],
                "Indices": [
                    ".apm-agent-configuration"
                ],
                "InstanceId": "es-ldmd4rpp",
                "IsLocked": 0,
                "KmsKey": "",
                "MultiAz": 0,
                "PaasEsRepository": "ES_AUTO_BACKUP_cosbackup4294967516",
                "RemoteCos": 0,
                "RemoteCosRegion": "ap-guangzhou",
                "Repository": "ES_AUTO_BACKUP_cosbackup4294967516",
                "RetainUntilDate": "",
                "RetentionGraceTime": 0,
                "SnapshotName": "test2-hour-snapshot_20260420_17",
                "StartTime": "2026-04-20T09:52:18.767Z",
                "State": "SUCCESS",
                "StorageDuration": 7,
                "StrategyName": "test2-hour",
                "SuccessfulShards": 14,
                "TotalShards": 14,
                "UserBackUp": "false",
                "UserEsRepository": "",
                "Uuid": "BI8atOQtRoO5p4BZSgX0OA",
                "Version": "7.14.2"
            }
        ],
        "RequestId": "378df927-e4af-4950-a521-29d72846cc23"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InvalidParameter.InvalidAppId AppId的取值和预期不符。
InvalidParameter.InvalidUin Uin的取值和预期不符。
LimitExceeded.ResponseTimeout 后端服务响应时间超过配额限制
ResourceNotFound.DBInfoNotFound 数据库资源获取失败。
中国站