恢复快照

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID和名称。

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及

cluster_id

是

String

参数解释：

指定集群ID。获取方法请参见获取集群ID。

约束限制：

不涉及

取值范围：

集群ID。

默认取值：

不涉及

snapshot_id

是

String

参数解释：

快照ID。获取方法请参见查询快照列表。

约束限制：

快照状态为可用。

取值范围：

不涉及

默认取值：

不涉及

target_cluster

是

String

参数解释：

目标集群ID，即快照要恢复到哪个集群。

约束限制：

• 当前集群可用时，快照默认恢复到当前集群，但也可以恢复到其他集群。

• 目标集群必须和当前集群在相同的Region，且目标集群的版本要等于或者高于当前集群。

取值范围：

不涉及

默认取值：

不涉及

indices

否

String

参数解释：

指定需要进行恢复的索引名。

约束限制：

• 支持0～1024个字符，不支持大写字母、空格以及字符“"<|>/?”。

• 恢复以“.kibana”为前缀的索引时需要指定索引名称。

• “.opendistro_security”索引不允许恢复。

取值范围：

• 支持使用“*”匹配多个索引，比如“index*”，表示恢复快照中名称前缀是index的所有索引。使用“*”匹配索引时，默认会过滤掉“.opendistro_security”或以“.kibana”为前缀的系统索引。

• 支持恢复指定的索引，比如“index1,index2,index3”。

默认取值：

默认为空，即不指定索引名称，表示恢复所有的索引数据。

rename_pattern

否

String

参数解释：

匹配要恢复的索引规则。

约束限制：

• 根据此处定义的过滤条件去恢复符合条件的索引，过滤条件请使用正则表达式。

• renamePattern参数与renameReplacement参数必须同时设置才能生效。

取值范围：

0～1024个字符，不能包含空格和大写字母，且不能包含"\<|>/?,特殊字符。

默认取值：

不涉及

rename_replacement

否

String

参数解释：

索引重命名的规则。

约束限制：

renamePattern参数与renameReplacement参数必须同时设置才能生效。

取值范围：

0～1024个字符，不能包含空格和大写字母，且不能包含"\<|>/?,特殊字符。例如，“restored_index_$1”表示在所有恢复的索引名称前面加上“restored_”。

默认取值：

不涉及

replace_exist_indices

否

Boolean

参数解释：

是否覆盖目标集群同名索引。快照恢复将覆盖目标集群数据，如果目标集群存在同名索引需勾选覆盖以恢复相同分片结构的索引，不同分片结构的索引不可恢复，请谨慎操作。

约束限制：

不涉及

取值范围：

• false：不替换已存在的索引。

• true：替换已存在的索引。

默认取值：

false

201

创建类的请求成功。

400

非法请求。

建议直接修改该请求，不要重试该请求。

403

请求被拒绝访问。

返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。