› › ›

API компонентов шаблонов

API cat предназначены только для использования людьми через командную строку или консоль Kibana. Они не предназначены для использования приложениями. Для использования приложениями используйте API получения шаблона компонента.

Возвращает информацию о шаблонах компонентов в кластере. Шаблоны компонентов являются строительными блоками для построения шаблонов индексов, которые определяют мапинг индексов, параметры и псевдонимы.

Запрос

GET /_cat/component_templates/<template_name>

GET /_cat/component_templates

Предварительные условия

Если включены функции безопасности Elasticsearch, у вас должна быть роль monitor или manage права доступа к кластеру, чтобы использовать этот 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.component_templates(
    name="my-template-*",
    v=True,
    s="name",
)
print(resp)

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

const response = await client.cat.componentTemplates({
  name: "my-template-*",
  v: "true",
  s: "name",
});
console.log(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]

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cat-component-templates.html