手动创建快照
功能介绍
CSS服务的快照备份功能为Elasticsearch集群提供数据保护和恢复能力。通过快照备份，可以将集群的数据状态保存到OBS桶中，以便在需要时进行恢复。CSS集群快照分为两种方式：自动创建快照和手动创建快照。
-
自动创建快照：按照预设的时间策略自动执行快照备份操作，适合定期备份场景，例如每日或每周备份，以确保数据的持续保护。通过设置自动快照策略，用户可以减少手动操作，提高备份的可靠性和效率。
-
手动创建快照：用户根据需求手动触发快照备份操作，适合临时备份或特定场景，如在进行重大操作前（如集群升级）进行备份，以便在出现问题时能够快速恢复到之前的状态。手动快照提供了更高的灵活性，用户可以根据实际需求随时创建快照。
该接口用于手动创建一个快照。
调用方法
请参见如何调用API。
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释： 快照名称。 约束限制： 不涉及 取值范围： 快照名称在4位到64位之间，必须以字母开头，可以包含字母、数字、中划线或者下划线，注意字母不能大写且不能包含其他特殊字符。 默认取值： 不涉及 |
|
description |
否 |
String |
参数解释： 快照描述。 约束限制： 不涉及 取值范围： 0～256个字符，不能包含!<>=&"'字符。 默认取值： 不涉及 |
|
indices |
否 |
String |
参数解释： 指定要备份的索引名称，多个索引用逗号隔开，默认备份所有索引。支持使用“*”匹配多个索引，例如：2018-06*，表示备份名称前缀是2018-06的所有索引的数据。 约束限制： 不涉及 取值范围： 0～1024个字符，不能包含空格和大写字母，且不能包含"\<|>/?特殊字符。 默认取值： *，表示全部索引。 |
请求示例
创建快照。
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot
{
"name" : "snapshot_001",
"indices" : "myindex1myindex2"
}
响应示例
状态码：201
创建类的请求已成功。
{
"backup" : {
"id" : "9dc4f5c9-33c0-45c7-9378-ae35ae350682",
"name" : "snapshot_101"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
创建类的请求已成功。 |
|
400 |
非法请求。 建议直接修改该请求，不要重试该请求。 |
|
403 |
请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 |
|
406 |
服务器无法根据客户端请求的内容特性完成请求。 |
|
500 |
表明服务端能被请求访问到，但是不能理解用户的请求。 |
|
501 |
服务器不支持请求的功能，无法完成请求。 |
错误码
请参见错误码。
