Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›API индексов

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

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

Справочник по новым API

Для получения самых актуальных данных об API обратитесь к API индексов.

Проверяет существование устаревшего шаблона индекса.

resp = client.indices.exists_template(
    name="template_1",
)
print(resp)
response = client.indices.exists_template(
  name: 'template_1'
)
puts response
const response = await client.indices.existsTemplate({
  name: "template_1",
});
console.log(response);
HEAD /_template/template_1

Запрос

HEAD /_template/<index-template>

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

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

Описание

Используйте API проверки существования шаблона индекса, чтобы определить, существуют ли один или несколько шаблонов индексов.

Шаблоны индексов определяют настройки, отображения и псевдонимы, которые могут автоматически применяться к новым индексам.

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

<index-template>
(Обязательный, строка) Список шаблонов индексов через запятую для ограничения запроса. Поддерживаются выражения с подстановкой (*).

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

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

Коды ответов

200
Указывает, что все указанные шаблоны индексов существуют.
404
Указывает, что один или несколько указанных шаблонов индексов не существуют.

© 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-template-exists-v1.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API