« Search Application APIs Security APIs »
Elastic Docs ›Elasticsearch Guide ›REST APIs

可搜索快照API

edit

可搜索快照API

edit

您可以使用以下API来执行可搜索快照操作。

挂载快照 API

edit

将快照挂载为可搜索的快照索引。

请求

edit

POST /_snapshot///_mount

先决条件

edit

如果启用了Elasticsearch安全功能，您必须拥有manage集群权限和manage索引权限，才能使用此API。 有关更多信息，请参阅安全权限。

描述

edit

此API将快照挂载为可搜索的快照索引。

不要将此API用于由ILM管理的快照。手动挂载由ILM管理的快照可能会干扰 ILM流程。

路径参数

edit
<repository>
(必需，字符串) 包含要挂载的索引快照的仓库名称。
<snapshot>
(必需, 字符串) 要挂载的索引快照的名称。

查询参数

edit
master_timeout
(可选，时间单位) 等待主节点的时间段。如果在超时到期之前主节点不可用，请求将失败并返回错误。默认为30s。 也可以设置为-1，表示请求不应超时。
wait_for_completion
(可选，布尔值) 如果 true，请求会阻塞直到操作完成。 默认为 false。
storage

(可选，字符串) 挂载选项 用于可搜索快照索引。可能的值有：

full_copy (默认)
完全挂载的索引。
shared_cache
部分挂载的索引。

请求体

edit
index
(必需，字符串) 快照中包含的索引名称，其数据将被挂载。

如果没有指定renamed_index，此名称也将用于创建新索引。

renamed_index

(可选, 字符串) 要创建的索引的名称。

index_settings

(可选, 对象) 在挂载索引时应添加的设置。

ignore_index_settings

(可选，字符串数组) 在索引挂载时应从中移除的设置名称。

示例

edit

从存储在my_repository中的现有快照my_snapshot挂载索引my_docs作为新的索引docs：

POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true
{
  "index": "my_docs", 
  "renamed_index": "docs", 
  "index_settings": { 
    "index.number_of_replicas": 0
  },
  "ignore_index_settings": [ "index.refresh_interval" ] 
}

快照中要挂载的索引名称

要创建的索引名称

要添加到新索引的任何索引设置

在挂载快照索引时要忽略的索引设置列表

缓存统计 API

edit

检索关于部分挂载索引的共享缓存的统计信息。

请求

edit

GET /_searchable_snapshots/cache/stats

GET /_searchable_snapshots//cache/stats

先决条件

edit

如果启用了Elasticsearch安全功能，您必须拥有manage集群权限才能使用此API。更多信息，请参阅安全权限。

路径参数

edit
<node_id>
(可选，字符串) 要定位的集群中特定节点的名称。 例如，nodeId1,nodeId2。有关节点选择选项，请参阅 节点规范。

响应体

edit
nodes

(对象) 包含请求选择的节点的统计信息。

Properties of nodes

(对象) 包含指定标识符节点的统计信息。

Properties of
shared_cache

(对象) 包含关于共享缓存文件的统计信息。

Properties of shared_cache
reads
(长整型) 共享缓存用于读取数据的次数。
bytes_read_in_bytes
(长整型) 从共享缓存读取的总字节数。
writes
(长整型) 从blob存储库写入共享缓存的数据次数。
bytes_written_in_bytes
(长整型) 写入共享缓存的总字节数。
evictions
(长整型) 从共享缓存文件中驱逐的区域数量。
num_regions
(整数) 共享缓存文件中的区域数量。
size_in_bytes
(长整型) 共享缓存文件的总大小（字节）。
region_size_in_bytes
(长整型) 共享缓存文件中一个区域的大小（字节）。

示例

edit

获取所有数据节点中部分挂载索引的共享缓存的统计信息：

GET /_searchable_snapshots/cache/stats

API返回以下响应：

{
  "nodes" : {
    "eerrtBMtQEisohZzxBLUSw" : {
      "shared_cache" : {
        "reads" : 6051,
        "bytes_read_in_bytes" : 5448829,
        "writes" : 37,
        "bytes_written_in_bytes" : 1208320,
        "evictions" : 5,
        "num_regions" : 65536,
        "size_in_bytes" : 1099511627776,
        "region_size_in_bytes" : 16777216
      }
    }
  }
}

可搜索快照统计 API

edit

此功能处于技术预览阶段，可能会在未来的版本中进行更改或移除。Elastic 将努力修复任何问题，但技术预览版中的功能不受官方 GA 功能支持 SLA 的约束。

检索关于可搜索快照的统计信息。

请求

edit

GET /_searchable_snapshots/stats

GET //_searchable_snapshots/stats

先决条件

edit

如果启用了Elasticsearch的安全功能，您必须拥有manage 集群权限才能使用此API。您还必须 拥有manage 索引权限用于目标 数据流或索引。

描述

edit

路径参数

edit
<target>
(可选，字符串) 逗号分隔的数据流和索引列表，用于检索统计信息。要检索所有数据流和索引的统计信息，请省略此参数。

示例

edit

检索索引 my-index 的统计信息：

GET /my-index/_searchable_snapshots/stats

清除缓存 API

edit

此功能处于技术预览阶段，可能会在未来的版本中进行更改或移除。Elastic 将努力修复任何问题，但技术预览版中的功能不受官方 GA 功能支持 SLA 的约束。

清除共享缓存中的索引和数据流，适用于部分挂载的索引。

请求

edit

POST /_searchable_snapshots/cache/clear

POST //_searchable_snapshots/cache/clear

先决条件

edit

如果启用了Elasticsearch的安全功能，您必须拥有manage 集群权限才能使用此API。您还必须 拥有manage 索引权限用于目标 数据流、索引或别名。

路径参数

edit
<target>
(可选，字符串) 逗号分隔的数据流、索引和别名列表，用于从缓存中清除。支持通配符 (*)。要清除整个缓存，请省略此参数。

示例

edit

清除索引 my-index 的缓存：

POST /my-index/_searchable_snapshots/cache/clear
« Search Application APIs Security APIs »