恢复快照 API
编辑恢复快照 API
编辑恢复集群或指定数据流和索引的快照。
resp = client.snapshot.restore(
repository="my_repository",
snapshot="my_snapshot",
)
print(resp)
response = client.snapshot.restore( repository: 'my_repository', snapshot: 'my_snapshot' ) puts response
const response = await client.snapshot.restore({
repository: "my_repository",
snapshot: "my_snapshot",
});
console.log(response);
POST /_snapshot/my_repository/my_snapshot/_restore
请求
编辑POST /_snapshot/<repository>/<snapshot>/_restore
先决条件
编辑- 如果您使用 Elasticsearch 安全功能，您必须具有
manage或cluster:admin/snapshot/*集群权限才能使用此 API。
- 您只能将快照恢复到已选出主节点的正在运行的集群。快照的存储库必须已注册并可用于集群。
- 快照和集群版本必须兼容。请参阅快照兼容性。
- 要恢复快照，集群的全局元数据必须是可写的。请确保没有任何阻止写入的集群块。恢复操作将忽略索引块。
-
在恢复数据流之前，请确保集群包含启用了数据流的匹配索引模板。要检查，请使用 Kibana 的 索引管理 功能或 获取索引模板 API
resp = client.indices.get_index_template( name="*", filter_path="index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream", ) print(resp)response = client.indices.get_index_template( name: '*', filter_path: 'index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream' ) puts response
const response = await client.indices.getIndexTemplate({ name: "*", filter_path: "index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream", }); console.log(response);GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream
如果不存在这样的模板，您可以创建一个模板或恢复包含一个模板的集群状态。如果没有匹配的索引模板，数据流将无法滚动或创建后备索引。
- 如果您的快照包含来自 App Search 或 Workplace Search 的数据，请确保在恢复快照之前恢复Enterprise Search 加密密钥。
路径参数
编辑-
<repository> - （必需，字符串）要从中恢复快照的存储库的名称。
-
<snapshot> - （必需，字符串）要恢复的快照的名称。
查询参数
编辑-
master_timeout - （可选，时间单位）等待主节点的时间。如果主节点在超时到期之前不可用，则请求失败并返回错误。默认为
30s。也可以设置为-1表示请求永远不应超时。 -
wait_for_completion -
（可选，布尔值）如果为
true，则在恢复操作完成时请求返回响应。当恢复操作完成所有尝试恢复已恢复索引的主分片时，操作完成。即使一个或多个恢复尝试失败，这也适用。如果为
false，则在恢复操作初始化时请求返回响应。默认为false。
请求体
编辑-
ignore_unavailable - （可选，布尔值）如果为
true，则请求会忽略indices中快照中缺少的任何索引或数据流。如果为false，则请求会为任何丢失的索引或数据流返回错误。默认为false。 -
ignore_index_settings -
（可选，字符串或字符串数组）不从快照恢复的索引设置。您不能使用此选项来忽略
index.number_of_shards。对于数据流，此选项仅适用于恢复的后备索引。新的后备索引使用数据流的匹配索引模板进行配置。
-
include_aliases - （可选，布尔值）如果为
true，则请求会恢复任何已恢复的数据流和索引的别名。如果为false，则请求不会恢复别名。默认为true。
-
include_global_state -
（可选，布尔值）如果为
true，则恢复集群状态。默认为false。集群状态包括
如果
include_global_state为true，则恢复操作会将集群中的旧索引模板与快照中包含的模板合并，替换快照中名称匹配的任何现有模板。它会完全删除集群中存在的所有持久设置、非旧索引模板、Ingest 管道和 ILM 生命周期策略，并将其替换为快照中的相应项。使用
feature_states参数配置功能状态的恢复方式。如果
include_global_state为true，并且创建的快照没有全局状态，则恢复请求将失败。
-
feature_states -
（可选，字符串数组）要恢复的功能状态。
如果
include_global_state为true，则请求默认会恢复快照中的所有功能状态。如果include_global_state为false，则请求默认不恢复任何功能状态。请注意，指定一个空数组将导致默认行为。要不恢复任何功能状态（无论include_global_state值如何），请指定一个仅包含值none(["none"]) 的数组。
-
index_settings -
（可选，对象）要在恢复的索引（包括后备索引）中添加或更改的索引设置。您不能使用此选项来更改
index.number_of_shards。对于数据流，此选项仅适用于恢复的后备索引。新的后备索引使用数据流的匹配索引模板进行配置。
-
indices -
（可选，字符串或字符串数组）要恢复的索引和数据流的逗号分隔列表。支持多目标语法。默认为快照中的所有常规索引和常规数据流。
您不能使用此参数来恢复系统索引或系统数据流。请改用
feature_states。
-
partial -
（可选，布尔值）如果为
false，则如果快照中包含的一个或多个索引没有所有可用的主分片，则整个恢复操作将失败。默认为false。如果为
true，则允许恢复具有不可用分片的索引的部分快照。仅会恢复快照中成功包含的分片。所有缺少的分片都将重新创建为空。
-
rename_pattern -
（可选，字符串）定义要应用于恢复的数据流和索引的重命名模式。与重命名模式匹配的数据流和索引将根据
rename_replacement重命名。重命名模式的应用方式由正则表达式定义，该正则表达式支持根据
appendReplacement逻辑引用原始文本。
-
rename_replacement - （可选，字符串）定义重命名替换字符串。有关详细信息，请参阅
rename_pattern。
示例
编辑恢复已重命名的内容
编辑以下请求从 snapshot_2 中恢复 index_1 和 index_2。rename_pattern 和 rename_replacement 参数指示任何与正则表达式 index_(.+) 匹配的索引在恢复时将使用模式 restored_index_$1 进行重命名。
例如，index_1 将重命名为 restored_index_1。index_2 将重命名为 restored_index_2。
resp = client.snapshot.restore(
repository="my_repository",
snapshot="snapshot_2",
wait_for_completion=True,
indices="index_1,index_2",
ignore_unavailable=True,
include_global_state=False,
rename_pattern="index_(.+)",
rename_replacement="restored_index_$1",
include_aliases=False,
)
print(resp)
response = client.snapshot.restore(
repository: 'my_repository',
snapshot: 'snapshot_2',
wait_for_completion: true,
body: {
indices: 'index_1,index_2',
ignore_unavailable: true,
include_global_state: false,
rename_pattern: 'index_(.+)',
rename_replacement: 'restored_index_$1',
include_aliases: false
}
)
puts response
const response = await client.snapshot.restore({
repository: "my_repository",
snapshot: "snapshot_2",
wait_for_completion: "true",
indices: "index_1,index_2",
ignore_unavailable: true,
include_global_state: false,
rename_pattern: "index_(.+)",
rename_replacement: "restored_index_$1",
include_aliases: false,
});
console.log(response);
POST /_snapshot/my_repository/snapshot_2/_restore?wait_for_completion=true
{
"indices": "index_1,index_2",
"ignore_unavailable": true,
"include_global_state": false,
"rename_pattern": "index_(.+)",
"rename_replacement": "restored_index_$1",
"include_aliases": false
}
如果请求成功，API 将返回确认信息。如果请求遇到错误，则响应会指示发现的任何问题，例如阻止恢复操作完成的打开索引。
原地恢复
编辑您可能希望就地恢复索引，例如，当集群分配解释 API 报告 no_valid_shard_copy 后没有出现其他替代选项时。
以下请求关闭 index_1，然后从 my_repository 存储库中的 snapshot_2 快照中就地恢复它。
resp = client.indices.close(
index="index_1",
)
print(resp)
resp1 = client.snapshot.restore(
repository="my_repository",
snapshot="snapshot_2",
wait_for_completion=True,
indices="index_1",
)
print(resp1)
response = client.indices.close(
index: 'index_1'
)
puts response
response = client.snapshot.restore(
repository: 'my_repository',
snapshot: 'snapshot_2',
wait_for_completion: true,
body: {
indices: 'index_1'
}
)
puts response
const response = await client.indices.close({
index: "index_1",
});
console.log(response);
const response1 = await client.snapshot.restore({
repository: "my_repository",
snapshot: "snapshot_2",
wait_for_completion: "true",
indices: "index_1",
});
console.log(response1);
POST index_1/_close
POST /_snapshot/my_repository/snapshot_2/_restore?wait_for_completion=true
{
"indices": "index_1"
}