1. 接口描述
接口请求域名： es.tencentcloudapi.com 。
集群快照手动创建
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateClusterSnapshot。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例名称 示例值：es-xxx |
| SnapshotName | 是 | String | 快照名称 示例值：test-snapshot_20220202 |
| Indices | 否 | String | 索引名称 示例值：index1,index2 |
| EsRepositoryType | 否 | Integer | 0 腾讯云仓库; 1 客户仓库 示例值：0 |
| UserEsRepository | 否 | String | 客户快照仓库名称 示例值：UserEsRepository |
| StorageDuration | 否 | Integer | 快照存储周期 单位天，范围[0, INF), 如果没有设置则默认7天 示例值：3 |
| CosRetention | 否 | Integer | 备份锁定 0 不锁定; 1 锁定 示例值：0 |
| RetainUntilDate | 否 | String | 锁定截止日期 2022-12-10T08:34:48.000Z 示例值：2022-12-10T08:34:48.000Z |
| RetentionGraceTime | 否 | Integer | 锁定宽限期,单位天 示例值：7 |
| RemoteCos | 否 | Integer | 跨地域备份 0 不跨地域; 1 跨地域 示例值：0 |
| RemoteCosRegion | 否 | String | 跨地域备份地域名称 ap-guangzhou 示例值：ap-guangzhou |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：es-xxxx |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 集群快照手动创建
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateClusterSnapshot
<公共请求参数>
{
"InstanceId": "es-xxx",
"SnapshotName": "es-xxx-test_20240912",
"Indices": "kibana_sample_data_flights"
}输出示例
{
"Response": {
"InstanceId": "es-xxx",
"RequestId": "16eaxxxx-xxxx-xxxx-xxxx-xxxxxe45ae3c"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ErrorClusterState | 集群状态错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidEsVersion | 实例版本EsVersion的取值和预期不符。 |
| InvalidParameter.InvalidUin | Uin的取值和预期不符。 |
| ResourceNotFound.ClusterInfoNotFound | 集群资源获取失败。 |
| UnsupportedOperation.Plugin | 不支持该插件。 |
