恢复快照
功能介绍
该接口用于手动恢复一个快照。
调用方法
请参见如何调用API。
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restore
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID和名称。 |
|
cluster_id |
是 |
String |
恢复快照所属的集群ID。 |
|
snapshot_id |
是 |
String |
快照ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
targetCluster |
是 |
String |
快照要恢复到的集群的ID。 |
|
indices |
否 |
String |
指定要恢复的索引名称，多个索引用逗号隔开，默认恢复所有索引。支持使用“*”匹配多个索引，例如：2018-06*，表示恢复名称前缀是2018-06的所有索引的数据。0～1024个字符，不能包含空格和大写字母，且不能包含"\<|>/?特殊字符。 |
|
renamePattern |
否 |
String |
匹配要恢复的索引规则，最大支持1024个字符。根据此处定义的过滤条件去恢复符合条件的索引，过滤条件请使用正则表达式。 0～1024个字符，不能包含空格和大写字母，且不能包含"\<|>/?,特殊字符。 renamePattern参数与renameReplacement参数必须同时设置才能生效。 |
|
renameReplacement |
否 |
String |
索引重命名的规则。0～1024个字符，不能包含空格和大写字母，且不能包含"\<|>/?,特殊字符。例如，“restored_index_$1”表示在所有恢复的索引名称前面加上“restored_”。 renamePattern参数与renameReplacement参数必须同时设置才能生效。 |
|
replace_exist_indices |
否 |
Boolean |
替换已存在的索引 |
响应参数
无
请求示例
恢复快照。
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/653c086f-ebe7-4383-b902-c031b354f1dd/restore
{
"targetCluster" : "ea244205-d641-45d9-9dcb-ab2236bcd07e",
"indices" : "myindex1,myindex2",
"renamePattern" : "index",
"renameReplacement" : "restored_index_$1"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
创建类的请求已成功。 |
|
400 |
非法请求。 建议直接修改该请求，不要重试该请求。 |
|
403 |
请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
