› › ›

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

Данная документация посвящена устаревшим шаблонам индексов, которые являются устаревшими и будут заменены составными шаблонами, представленными в Elasticsearch 7.8. Для получения информации о составных шаблонах см. Шаблоны индексов.

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

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

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

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

GET /_template/template_1

Запрос

GET /_template/<index-template>

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

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

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

<index-template>

(Обязательно, строка) Список имён шаблонов индексов, разделённых запятыми, для ограничения запроса. Поддерживаются выражения с подстановкой (*).

Чтобы вернуть все шаблоны индексов, опустите этот параметр или используйте значение _all или *.

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

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

Примеры

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

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

response = client.indices.get_template(
  name: 'template_1,template_2'
)
puts response

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

GET /_template/template_1,template_2

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

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

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

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

GET /_template/temp*

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

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

response = client.indices.get_template
puts response

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

GET /_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-v1.html