cat 模板 API
编辑cat 模板 API
编辑cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用,请使用 获取索引模板 API。
返回有关集群中索引模板的信息。您可以使用索引模板在创建新索引时应用索引设置和字段映射。
路径参数
编辑-
<template_name>
- (可选,字符串)要返回的模板的名称。接受通配符表达式。如果省略,则返回所有模板。
查询参数
编辑-
format
- (可选,字符串)HTTP accept 标头的简短版本。有效值包括 JSON、YAML 等。
-
h
- (可选,字符串)要显示的列名称的逗号分隔列表。
-
help
- (可选,布尔值)如果为
true
,则响应包括帮助信息。默认为false
。 -
local
- (可选,布尔值)如果为
true
,则请求仅从本地节点检索信息。默认为false
,这意味着从主节点检索信息。 -
master_timeout
- (可选,时间单位)等待主节点的周期。如果主节点在超时过期之前不可用,则请求失败并返回错误。默认为
30s
。也可以设置为-1
,表示请求永远不应超时。 -
s
- (可选,字符串)用于对响应进行排序的列名称或列别名的逗号分隔列表。
-
v
- (可选,布尔值)如果为
true
,则响应包括列标题。默认为false
。
示例
编辑resp = client.cat.templates( name="my-template-*", v=True, s="name", ) print(resp)
response = client.cat.templates( name: 'my-template-*', v: true, s: 'name' ) puts response
const response = await client.cat.templates({ name: "my-template-*", v: "true", s: "name", }); console.log(response);
GET _cat/templates/my-template-*?v=true&s=name
API 返回以下响应
name index_patterns order version composed_of my-template-0 [te*] 500 [] my-template-1 [tea*] 501 [] my-template-2 [teak*] 502 7 []