« 可搜索快照 API 缓存统计 API »

› › ›

挂载快照 API

挂载快照 API

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

请求

POST /_snapshot/<repository>/<snapshot>/_mount

前提条件

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

描述

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

请勿将此 API 用于 ILM 管理的快照。手动挂载 ILM 管理的快照会干扰 ILM 进程。

路径参数

<repository>: （必需，字符串）包含要挂载的索引快照的存储库的名称。
<snapshot>: （必需，字符串）要挂载的索引快照的名称。

查询参数

master_timeout

（可选，时间单位）等待主节点的时间段。如果在超时过期之前主节点不可用，则请求失败并返回错误。默认为 30s。也可以设置为 -1 以表示请求永远不应超时。

wait_for_completion

（可选，布尔值）如果为 true，则请求会阻塞，直到操作完成。默认为 false。

storage

（可选，字符串）可搜索快照索引的挂载选项。可能的值为

full_copy（默认）: 完全挂载的索引.
shared_cache: 部分挂载的索引.

请求体

index: （必需，字符串）要挂载的数据的快照中包含的索引的名称。

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

renamed_index: （可选，字符串）将要创建的索引的名称。
index_settings: （可选，对象）在挂载索引时应添加到索引的设置。
ignore_index_settings: （可选，字符串数组）在挂载索引时应从索引中删除的设置的名称。

示例

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

resp = client.searchable_snapshots.mount(
    repository="my_repository",
    snapshot="my_snapshot",
    wait_for_completion=True,
    index="my_docs",
    renamed_index="docs",
    index_settings={
        "index.number_of_replicas": 0
    },
    ignore_index_settings=[
        "index.refresh_interval"
    ],
)
print(resp)

const response = await client.searchableSnapshots.mount({
  repository: "my_repository",
  snapshot: "my_snapshot",
  wait_for_completion: "true",
  index: "my_docs",
  renamed_index: "docs",
  index_settings: {
    "index.number_of_replicas": 0,
  },
  ignore_index_settings: ["index.refresh_interval"],
});
console.log(response);

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 缓存统计 API »