« 获取快照状态 API 删除快照 API »
Elastic 文档 ›Elasticsearch 指南 [8.14] ›REST API ›快照和恢复 API

恢复快照 API

编辑

恢复快照 API编辑

恢复集群或指定数据流和索引的 快照。

response = client.snapshot.restore(
  repository: 'my_repository',
  snapshot: 'my_snapshot'
)
puts response
POST /_snapshot/my_repository/my_snapshot/_restore

请求编辑

POST /_snapshot/<repository>/<snapshot>/_restore

先决条件编辑

  • 如果您使用 Elasticsearch 安全功能，则必须具有 manage 或 cluster:admin/snapshot/* 集群权限才能使用此 API。
  • 您只能将快照恢复到具有已选举 主节点 的正在运行的集群。快照的存储库必须 注册 并可供集群使用。
  • 快照和集群版本必须兼容。请参阅 快照兼容性。
  • 要恢复快照，集群的全局元数据必须可写。确保没有阻止写入的 集群块。恢复操作会忽略 索引块。

  • 在恢复数据流之前，请确保集群包含一个 匹配的索引模板，并且数据流已启用。要检查，请使用 Kibana 的 索引管理 功能或 获取索引模板 API

    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
    GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream

    如果不存在此类模板，您可以 创建一个 或 恢复包含一个的集群状态。如果没有匹配的索引模板，数据流将无法滚动或创建支持索引。

  • 如果您的快照包含来自 App Search 或 Workplace 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，则恢复操作会将集群中的旧版索引模板与快照中包含的模板合并，替换任何名称与快照中名称匹配的现有模板。它会完全删除集群中存在的任何持久设置、非旧版索引模板、摄取管道和 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。

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
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 快照中就地恢复它。

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
POST index_1/_close

POST /_snapshot/my_repository/snapshot_2/_restore?wait_for_completion=true
{
  "indices": "index_1"
}
« 获取快照状态 API 删除快照 API »