API создания или обновления шаблона индекса

Вы можете использовать комментарии в стиле C /* */ в шаблонах индексов. Вы можете включать комментарии где угодно в теле запроса, кроме места перед открывающей фигурной скобкой.

Вы можете включить псевдонимы индексов в шаблон индекса.

PUT _index_template/template_1
{
  "index_patterns" : ["te*"],
  "template": {
    "settings" : {
        "number_of_shards" : 1
    },
    "aliases" : {
        "alias1" : {},
        "alias2" : {
            "filter" : {
                "term" : {"user.id" : "kimchy" }
            },
            "routing" : "shard-1"
        },
        "{index}-alias" : {} 
    }
  }
}

Если несколько шаблонов индексов соответствуют имени нового индекса или потока данных, используется шаблон с наивысшим приоритетом. Например:

PUT /_index_template/template_1
{
  "index_patterns" : ["t*"],
  "priority" : 0,
  "template": {
    "settings" : {
      "number_of_shards" : 1,
      "number_of_replicas": 0
    },
    "mappings" : {
      "_source" : { "enabled" : false }
    }
  }
}

PUT /_index_template/template_2
{
  "index_patterns" : ["te*"],
  "priority" : 1,
  "template": {
    "settings" : {
      "number_of_shards" : 2
    },
    "mappings" : {
      "_source" : { "enabled" : true }
    }
  }
}

Для индексов, начинающихся с te*, _source будет включено, и индекс будет иметь два первичных фрагмента и один реплика, потому что только template_2 будет применён.

Вы можете использовать параметр version для добавления номера версии к шаблону индекса. Внешние системы могут использовать эти номера версий для упрощения управления шаблонами.

Параметр version является необязательным и не генерируется и не используется Elasticsearch автоматически.

Чтобы сбросить version, замените шаблон, не указывая его.

PUT /_index_template/template_1
{
  "index_patterns" : ["foo", "bar"],
  "priority" : 0,
  "template": {
    "settings" : {
        "number_of_shards" : 1
    }
  },
  "version": 123
}

Чтобы проверить version, вы можете использовать API получения шаблона индекса.

Вы можете использовать параметр _meta для добавления произвольных метаданных к шаблону индекса. Этот определяемый пользователем объект хранится в состоянии кластера, поэтому желательно сохранять его коротким.

Параметр _meta является необязательным и не генерируется и не используется Elasticsearch автоматически.

Чтобы сбросить _meta, замените шаблон, не указывая его.

PUT /_index_template/template_1
{
  "index_patterns": ["foo", "bar"],
  "template": {
    "settings" : {
        "number_of_shards" : 3
    }
  },
  "_meta": {
    "description": "set number of shards to three",
    "serialization": {
      "class": "MyIndexTemplate",
      "id": 17
    }
  }
}

Чтобы проверить _meta, вы можете использовать API получения шаблона индекса.

Для использования шаблона индекса для потоков данных шаблон должен содержать объект data_stream. См. создание шаблона индекса.

PUT /_index_template/template_1
{
  "index_patterns": ["logs-*"],
  "data_stream": { }
}

Когда несколько шаблонов компонентов указаны в поле composed_of для шаблона индекса, они объединяются в указанном порядке, что означает, что последующие шаблоны компонентов перезаписывают предыдущие. Любые отображения, настройки или псевдонимы из родительского шаблона индекса объединяются далее. Наконец, любая конфигурация в самом запросе индекса объединяется.

В этом примере порядок двух шаблонов компонентов изменяет количество фрагментов индекса:

PUT /_component_template/template_with_2_shards
{
  "template": {
    "settings": {
      "index.number_of_shards": 2
    }
  }
}

PUT /_component_template/template_with_3_shards
{
  "template": {
    "settings": {
      "index.number_of_shards": 3
    }
  }
}

PUT /_index_template/template_1
{
  "index_patterns": ["t*"],
  "composed_of": ["template_with_2_shards", "template_with_3_shards"]
}

В этом случае индекс, соответствующий t*, будет иметь три первичных фрагмента. Если порядок составленных шаблонов был изменён, индекс имел бы два первичных фрагмента.

Определения отображений объединяются рекурсивно, что означает, что последующие компоненты отображений могут вводить новые отображения полей и обновлять конфигурацию отображения. Если отображение поля уже содержится в более раннем компоненте, его определение будет полностью перезаписано последующим.

Эта рекурсивная стратегия объединения применима не только к отображениям полей, но и к корневым параметрам, таким как dynamic_templates и meta. Если более ранний компонент содержит блок dynamic_templates, то по умолчанию новые записи dynamic_templates добавляются в конец. Если запись уже существует с тем же ключом, то она перезаписывается новым определением.