› › ›

API cat шаблонов

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.
s: (Необязательно, строка) Список имен столбцов или псевдонимов столбцов, разделенных запятыми, для сортировки ответа.
v: (Необязательно, логическое значение) Если true, в ответ включаются заголовки столбцов. По умолчанию false.

Примеры

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/7.17/cat-templates.html