获取索引模板 API编辑

本文档介绍的是旧版索引模板,这些模板已弃用,将由 Elasticsearch 7.8 中引入的可组合模板取代。有关可组合模板的信息,请参阅索引模板

检索有关一个或多个索引模板的信息。

response = client.indices.get_template(
  name: 'template_1'
)
puts response
GET /_template/template_1

请求编辑

GET /_template/<index-template>

先决条件编辑

  • 如果启用了 Elasticsearch 安全功能,则必须具有 manage_index_templatesmanage 集群权限 才能使用此 API。

路径参数编辑

<index-template>

(必填,字符串)用于限制请求的索引模板名称的逗号分隔列表。支持通配符 (*) 表达式。

要返回所有索引模板,请省略此参数或使用 _all* 值。

查询参数编辑

flat_settings
(可选,布尔值)如果为 true,则以平面格式返回设置。默认为 false
local
(可选,布尔值)如果为 true,则请求仅从本地节点检索信息。默认为 false,这意味着从主节点检索信息。
master_timeout
(可选,时间单位)等待主节点的时间。如果在超时到期之前主节点不可用,则请求失败并返回错误。默认为 30s。也可以设置为 -1 以指示请求永远不会超时。

示例编辑

获取多个索引模板编辑

response = client.indices.get_template(
  name: 'template_1,template_2'
)
puts response
GET /_template/template_1,template_2

使用通配符表达式获取索引模板编辑

response = client.indices.get_template(
  name: 'temp*'
)
puts response
GET /_template/temp*

获取所有索引模板编辑

response = client.indices.get_template
puts response
GET /_template