快照备份恢复

最近更新时间:2024-10-30 01:33:57

我的收藏

1. 接口描述

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

快照备份恢复,从仓库中恢复快照到集群中

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RestoreClusterSnapshot。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 集群实例Id,格式:es-xxxx
示例值:es-xxx
RepositoryName String 仓库名称
SnapshotName String 集群快照名称
TargetInstanceId String 目标集群实例Id,格式:es-xxxx,如果是恢复到本地,则和InstanceId一致
Password String elastic用户名对应的密码信息
IndexSettings String 要在所有恢复的索引中添加或更改的设置的逗号分隔列表。使用此参数可以在恢复快照时覆盖索引设置。
IncludeGlobalState.N Array of String 不应从快照还原的以逗号分隔的索引设置列表。
Indices String 需要恢复的索引名称,非必填,为空则表示恢复所有

支持传多个索引名称
Partial String 如果为 false,则如果快照中包含的一个或多个索引没有所有主分片可用,则整个恢复操作将失败。默认为 false,

如果为 true,则允许恢复具有不可用分片的索引的部分快照。只有成功包含在快照中的分片才会被恢复。所有丢失的碎片将被重新创建为空

3. 输出参数

参数名称 类型 描述
InstanceId String 集群实例id
示例值:es-xxx
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 RestoreClusterSnapshot 恢复快照数据到集群

输入示例

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

{
    "InstanceId": "es-qpzizjym",
    "Password": "abc",
    "RepositoryName": "ES_AUTO_BACKUP",
    "SnapshotName": "test1",
    "Indices": "abc",
    "Partial": "true",
    "TargetInstanceId": "es-qpzizjym"
}

输出示例

{
    "Response": {
        "InstanceId": "es-qpzizjym",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.InvalidEsVersion 实例版本EsVersion的取值和预期不符。
InvalidParameterValue.Password 密码校验不合法。
ResourceNotFound.CosInfoNotFound COS相关信息获取失败。