更新时间:2026-01-12 GMT+08:00

恢复快照

功能介绍

该接口用于手动恢复一个快照。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restore

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

恢复快照所属的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

snapshot_id

String

参数解释

快照ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

target_cluster

String

参数解释

快照要恢复到的集群的ID。

约束限制

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

  • 目标集群必须和当前集群在相同的Region区,且目标集群的云搜索服务版本要等于或者高于当前集群。

取值范围

不涉及

默认取值

不涉及

indices

String

参数解释

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

约束限制

  • 支持使用“*”匹配多个索引,比如index*,表示恢复快照中名称前缀是index的所有索引。

  • 也可恢复指定的索引,比如”index1,index2,index3“。

  • 使用“*”匹配索引时,默认会过滤掉“.opendistro_security”或以“.kibana”为前缀的系统索引。“.opendistro_security”索引不允许恢复,恢复以“.kibana”为前缀的索引时需要指定索引名称。

取值范围

0~1024个字符,不能包含大写字母、空格以及字符:"\<|>/?

默认取值

默认为空。

默认为空,表示恢复快照中的所有数据索引。

rename_pattern

String

参数解释

匹配要恢复的索引规则。

约束限制

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

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

取值范围

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

默认取值

不涉及

rename_replacement

String

参数解释

索引重命名的规则。

约束限制

不涉及

取值范围

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

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

默认取值

不涉及

replace_exist_indices

Boolean

参数解释

是否替换已存在的索引。

约束限制

不涉及

取值范围

  • false:不替换已存在的索引

  • true:替换已存在的索引

默认取值

false

响应参数

状态码:201

创建类的请求已成功。

请求示例

恢复快照。

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/653c086f-ebe7-4383-b902-c031b354f1dd/restore

{
  "target_cluster" : "ea244205-d641-45d9-9dcb-ab2236bcd07e",
  "indices" : "myindex1,myindex2",
  "rename_pattern" : "index",
  "rename_replacement" : "restored_index_$1"
}

响应示例

状态码

状态码

描述

201

创建类的请求已成功。

400

非法请求。

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

403

请求被拒绝访问。

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

错误码

请参见错误码