› › ›

API симуляции индекса

Данная функциональность находится в техническом предварительном просмотре и может быть изменена или удалена в будущих релизах. Elastic будет работать над устранением любых проблем, но функции в техническом предварительном просмотре не подпадают под SLA поддержки официальных функций GA.

Возвращает конфигурацию индекса, которая будет применена к указанному индексу из существующей шаблона индекса.

POST /_index_template/_simulate_index/my-index-000001

Запрос

POST /_index_template/_simulate_index/<index>

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

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

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

<index>: (Обязательный, строка) Имя индекса, который нужно смоделировать.

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

master_timeout: (Необязательный, единицы времени) Время ожидания соединения с узлом мастера. Если ответ не получен до истечения таймаута, запрос завершается с ошибкой. По умолчанию 30s.

Тело ответа

overlapping

(массив) Любые шаблоны, которые также соответствовали индексу, но были заменены шаблоном с более высоким приоритетом. Ответ включает пустой массив, если накладных шаблонов нет.

Свойства overlapping

name: (строка) Имя заменённого шаблона.
index_patterns: (массив) Шаблоны индексов, к которым применим заменённый шаблон.

template

(объект) Параметры, отображения и алиасы, которые будут применены к индексу.

Свойства template

aliases

(объект) Алиасы для индекса. Если алиасы не применимы, ответ возвращает пустой aliases объект.

<alias>

(объект) Ключ — имя алиаса. Тело объекта содержит параметры для алиаса.

Свойства <alias>

filter: (объект языка запросов) Запрос, используемый для ограничения документов, к которым может получить доступ алиас.
index_routing: (строка) Значение, используемое для маршрутизации операций индексирования на определённый фрагмент. Это переписывает значение routing для операций индексирования.
is_hidden: (Булево) Если true, алиас скрыт.
is_write_index: (Булево) Если true, индекс является индексом записи для алиаса.
routing: (строка) Значение, используемое для маршрутизации операций индексирования и поиска на определённый фрагмент.
search_routing: (строка) Значение, используемое для маршрутизации операций поиска на определённый фрагмент. Это переписывает значение routing для операций поиска.

mappings

(Необязательный, объект отображения) Отображение для полей в индексе. При указании это отображение может включать:

См. Отображение.

Опущено из ответа, если отображения не будут применены.

settings

(Необязательный, объект настроек индекса) Параметры конфигурации для индекса. См. Настройки индекса.

Ответ включает пустой объект, если настройки не будут применены.

Примеры

Следующий пример демонстрирует конфигурацию, которая будет применена к my-index-000001 существующим шаблоном.

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

PUT /_component_template/ct2                    
{
  "template": {
    "settings": {
      "index.number_of_replicas": 0
    },
    "mappings": {
      "properties": {
        "@timestamp": {
          "type": "date"
        }
      }
    }
  }
}

PUT /_index_template/final-template             
{
  "index_patterns": ["my-index-*"],
  "composed_of": ["ct1", "ct2"],
  "priority": 5
}

POST /_index_template/_simulate_index/my-index-000001

	Создайте шаблон компонента (`ct1`), устанавливающий количество фрагментов в 2.
	Создайте второй шаблон компонента (`ct2`), устанавливающий количество реплик в 0 и определяющий отображение.
	Создайте шаблон индекса (`final-template`), использующий шаблоны компонентов.
	Покажите конфигурацию, которая будет применена к `my-index-000001`.

В ответе показаны настройки индекса, отображения и алиасы, применяемые шаблоном final-template:

{
  "template" : {
    "settings" : {
      "index" : {
        "number_of_shards" : "2",
        "number_of_replicas" : "0"
      }
    },
    "mappings" : {
      "properties" : {
        "@timestamp" : {
          "type" : "date"
        }
      }
    },
    "aliases" : { }
  },
  "overlapping" : [
    {
      "name" : "template_1",
      "index_patterns" : [
        "my-index-*"
      ]
    }
  ]
}

© 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/indices-simulate-index.html