› › ›

API получения шаблонов индексов

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

resp = client.indices.get_index_template(
    name="template_1",
)
print(resp)

response = client.indices.get_index_template(
  name: 'template_1'
)
puts response

const response = await client.indices.getIndexTemplate({
  name: "template_1",
});
console.log(response);

GET /_index_template/template_1

Запрос

GET /_index_template/<index-template>

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

Если включены функции безопасности Elasticsearch, необходимо иметь manage_index_templates или manage право доступа к кластеру для использования этого API или monitor право доступа к кластеру для получения шаблонов.

Параметры пути

(Необязательно, строка) Имя шаблона индекса для возврата. Поддерживаются выражения с подстановкой шаблонов. Если параметр опущен, возвращаются все шаблоны.

Параметры запроса

flat_settings: (Необязательно, булево) Если true, возвращает настройки в плоском формате. По умолчанию false.
local: (Необязательно, булево) Если true, запрос получает информацию только с локального узла. По умолчанию false, что означает получение информации с мастер-узла.
master_timeout: (Необязательно, единицы измерения времени) Время ожидания мастер-узла. Если мастер-узел недоступен до истечения таймаута, запрос завершается ошибкой. По умолчанию 30s. Также можно установить значение -1, чтобы указать, что запрос никогда не должен зависнуть.
include_defaults: (Необязательно, булево) Функциональность в [предварительный просмотр] Данная функциональность находится на стадии предварительного просмотра и может быть изменена или удалена в будущих версиях. Elastic будет работать над устранением любых проблем, но функции предварительного просмотра не подпадают под SLA поддержки официальных функций GA. . Если true, возвращает все значения по умолчанию в ответе. По умолчанию false.

Примеры

Получение шаблонов индексов с использованием выражения подстановки шаблонов

resp = client.indices.get_index_template(
    name="temp*",
)
print(resp)

response = client.indices.get_index_template(
  name: 'temp*'
)
puts response

const response = await client.indices.getIndexTemplate({
  name: "temp*",
});
console.log(response);

GET /_index_template/temp*

Получение всех шаблонов индексов

resp = client.indices.get_index_template()
print(resp)

response = client.indices.get_index_template
puts response

const response = await client.indices.getIndexTemplate();
console.log(response);

GET /_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/indices-get-template.html