› › ›

cat 组件模板 API

编辑

cat 组件模板 API编辑

cat API 仅供人类通过命令行或 Kibana 控制台使用。它们*不*适用于应用程序使用。对于应用程序使用，请使用获取组件模板 API。

返回有关集群中组件模板的信息。组件模板是用于构建索引模板的构建块，这些模板指定索引映射、设置和别名。

请求编辑

GET /_cat/component_templates/<template_name>

GET /_cat/component_templates

先决条件编辑

如果启用了 Elasticsearch 安全功能，则您必须拥有 monitor 或 manage 集群权限才能使用此 API。

路径参数编辑

<template_name>: （可选，字符串）要返回的组件模板的名称。接受通配符表达式。如果省略，则返回所有组件模板。

查询参数编辑

format: （可选，字符串）HTTP 接受标头的简短版本。有效值包括 JSON、YAML 等。
h: （可选，字符串）要显示的列名称的逗号分隔列表。
help: （可选，布尔值）如果为 true，则响应包含帮助信息。默认为 false。
local: （可选，布尔值）如果为 true，则请求仅从本地节点检索信息。默认为 false，这意味着从主节点检索信息。
master_timeout: （可选，时间单位）等待主节点的时间段。如果在超时到期之前主节点不可用，则请求失败并返回错误。默认为 30s。也可以设置为 -1 以指示请求永远不会超时。
s: （可选，字符串）用于对响应进行排序的列名称或列别名的逗号分隔列表。
v: （可选，布尔值）如果为 true，则响应包含列标题。默认为 false。

示例编辑

response = client.cat.component_templates(
  name: 'my-template-*',
  v: true,
  s: 'name'
)
puts response

GET _cat/component_templates/my-template-*?v=true&s=name

API 返回以下响应

name          version alias_count mapping_count settings_count metadata_count included_in
my-template-1         0           0             1              0              [my-index-template]
my-template-2         0           3             0              0              [my-index-template]

« cat 异常检测器 API cat count API »