获取索引模板 API
编辑获取索引模板 API
编辑返回一个或多个索引模板的信息。
resp = client.indices.get_index_template( name="template_1", ) print(resp)
response = client.indices.get_index_template( name: 'template_1' ) puts response
const response = await client.indices.getIndexTemplate({ name: "template_1", }); console.log(response);
GET /_index_template/template_1
请求
编辑GET /_index_template/<index-template>
先决条件
编辑- 如果启用了 Elasticsearch 安全功能,您必须拥有
manage_index_templates
或manage
集群权限 才能使用此 API,或拥有monitor
集群权限来检索模板。
路径参数
编辑(可选,字符串)要返回的模板的名称。接受通配符表达式。如果省略,则返回所有模板。
查询参数
编辑-
flat_settings
- (可选,布尔值)如果为
true
,则以扁平格式返回设置。默认为false
。 -
local
- (可选,布尔值)如果为
true
,则请求仅从本地节点检索信息。默认为false
,这意味着信息从主节点检索。 -
master_timeout
- (可选,时间单位)等待主节点的时间段。如果主节点在超时到期之前不可用,则请求失败并返回错误。默认为
30s
。也可以设置为-1
以表示请求永远不应超时。 -
include_defaults
- (可选,布尔值) [预览] 此功能处于技术预览状态,可能会在未来的版本中更改或删除。Elastic 将努力修复任何问题,但技术预览中的功能不受官方 GA 功能的支持 SLA 的约束。 中的功能。如果为
true
,则在响应中返回所有默认设置。默认为false
。
示例
编辑使用通配符表达式获取索引模板
编辑resp = client.indices.get_index_template( name="temp*", ) print(resp)
response = client.indices.get_index_template( name: 'temp*' ) puts response
const response = await client.indices.getIndexTemplate({ name: "temp*", }); console.log(response);
GET /_index_template/temp*
获取所有索引模板
编辑resp = client.indices.get_index_template() print(resp)
response = client.indices.get_index_template puts response
const response = await client.indices.getIndexTemplate(); console.log(response);
GET /_index_template