获取快照备份列表

1. 接口描述

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

获取快照备份列表

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 DescribeClusterSnapshot 查询快照列表

输入示例

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

{
    "InstanceId": "es-f1m2enyd",
    "RepositoryName": "ES_AUTO_BACKUP",
    "SnapshotName": "abc"
}

输出示例

{
    "Response": {
        "RequestId": "50df75f7-ec95-4c32-b7b0-a8e98ae74fef11",
        "RepositoryName": "ES_AUTO_BACKUP",
        "InstanceId": "es-f1m2enyd",
        "Snapshots": [
            {
                "SnapshotName": "快照名称1",
                "Uuid": "OPoARqBBSKuEIdLPdp7_dA",
                "Version": "7.14.2",
                "Indices": [
                    "honorboardcloud-sit-logs",
                    "pushtoken_meta_info_v1_auto",
                    ".ds-logs-generic-default-2023.10.11-000002"
                ],
                "State": "SUCCESS",
                "StartTime": "2023-10-30T18:00:45.746Z",
                "EndTime": "2023-10-30T18:14:46.707Z",
                "DurationInMillis": 840961,
                "TotalShards": 316,
                "FailedShards": 0,
                "SuccessfulShards": 316,
                "Failures": [
                    {
                        "Index": "快照备份失败的索引名称",
                        "ShardId": 0,
                        "Reason": "快照失败的原因"
                    },
                    {
                        "Index": "快照备份失败的索引名称",
                        "ShardId": 0,
                        "Reason": "快照失败的原因"
                    }
                ]
            },
            {
                "SnapshotName": "快照名称1",
                "Uuid": "OPoARqBBSKuEIdLPdp7_dA",
                "Version": "7.14.2",
                "Indices": [
                    "honorboardcloud-sit-logs",
                    "pushtoken_meta_info_v1_auto",
                    ".ds-logs-generic-default-2023.10.11-000002"
                ],
                "State": "SUCCESS",
                "StartTime": "2023-10-30T18:00:45.746Z",
                "EndTime": "2023-10-30T18:14:46.707Z",
                "DurationInMillis": 840961,
                "TotalShards": 316,
                "FailedShards": 0,
                "SuccessfulShards": 316,
                "Failures": [
                    {
                        "Index": "快照备份失败的索引名称",
                        "ShardId": 0,
                        "Reason": "快照失败的原因"
                    },
                    {
                        "Index": "快照备份失败的索引名称",
                        "ShardId": 0,
                        "Reason": "快照失败的原因"
                    }
                ]
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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