Elasticsearch创建快照API详解

Elasticsearch创建快照API详解

elasticsearch 项目地址: https://gitcode.com/gh_mirrors/elas/elasticsearch

什么是快照

在Elasticsearch中，快照(Snapshot)是一种备份机制，它可以将集群当前的状态和数据保存到一个外部存储系统中。快照功能对于数据备份、灾难恢复和集群迁移等场景非常重要。

创建快照API概述

创建快照API允许用户对Elasticsearch集群或指定的数据流和索引进行快照备份。这个API提供了丰富的配置选项，可以满足不同场景下的备份需求。

API基本语法

创建快照API支持两种HTTP方法：

PUT /_snapshot//
POST /_snapshot//

路径参数

• : (必需) 快照仓库的名称
• : (必需) 快照的名称，支持日期数学表达式，且在仓库内必须唯一

查询参数

• wait_for_completion: (可选) 如果设为true，API将在快照完成后返回响应；如果设为false，API将在快照初始化后立即返回响应。默认为false。
• master_timeout: (可选) 等待主节点响应的时间

请求体参数详解

索引匹配控制

• expand_wildcards: 控制通配符如何匹配数据流和索引

  • all: 匹配所有数据流和索引，包括关闭和隐藏的
  • open: 仅匹配打开的数据流和索引
  • closed: 仅匹配关闭的索引
  • hidden: 匹配隐藏的数据流和索引
  • none: 不扩展通配符

• ignore_unavailable: 如果设为true，快照将忽略不存在的索引；如果设为false，遇到不存在的索引会导致快照失败。默认为false。

快照内容控制

• include_global_state: 是否包含集群状态(包括集群设置、索引模板等)。默认为true。
• indices: 要包含在快照中的索引列表，支持多目标语法。默认为空数组(包含所有常规索引)。
• feature_states: 要包含在快照中的功能状态列表。如果include_global_state为true，默认包含所有功能状态；如果为false，默认不包含任何功能状态。

其他选项

• metadata: 可以附加到快照的元数据(小于1024字节)
• partial: 如果设为true，即使某些索引的主分片不可用，也允许创建部分快照。默认为false。

实际应用示例

基本快照创建

PUT /_snapshot/my_repository/my_snapshot

这个最简单的例子会在名为"my_repository"的仓库中创建一个名为"my_snapshot"的快照。

带参数的快照创建

PUT /_snapshot/my_repository/snapshot_2?wait_for_completion=true
{
  "indices": "index_1,index_2",
  "ignore_unavailable": true,
  "include_global_state": false,
  "metadata": {
    "taken_by": "user123",
    "taken_because": "backup before upgrading"
  }
}

这个例子展示了更复杂的快照创建：

• 只备份index_1和index_2
• 忽略不存在的索引
• 不包含集群状态
• 添加了描述性元数据
• 等待快照完成才返回响应

响应结构解析

成功创建快照后，API会返回包含以下信息的JSON响应：

• 快照基本信息：名称、UUID、仓库、版本等
• 包含的内容：索引、数据流、功能状态
• 状态信息：开始时间、结束时间、持续时间
• 分片统计：总数、成功数、失败数
• 自定义元数据

最佳实践

1. 定期备份：建立定期创建快照的机制，确保数据安全
2. 命名规范：使用有意义的快照名称，可以包含日期信息
3. 元数据记录：利用metadata字段记录快照的用途和创建者
4. 测试恢复：定期测试从快照恢复数据的过程
5. 监控空间：监控快照仓库的存储空间使用情况

安全考虑

如果启用了Elasticsearch的安全功能，用户必须具有create_snapshot或manage集群权限才能使用此API。

通过掌握创建快照API，您可以有效地保护Elasticsearch集群中的数据，为可能发生的意外情况做好准备。

elasticsearch 项目地址: https://gitcode.com/gh_mirrors/elas/elasticsearch