› › ›

API cat templates

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

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

Запрос

GET /_cat/templates/<template_name>

GET /_cat/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.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       []

© 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-templates.html