Spec-Zone.ru › Elasticsearch 7
›Elasticsearch Руководство [7.17] ›REST API ›Конвенции API

Синтаксис для нескольких целей

Большинство API, которые принимают параметр пути запроса <data-stream>, <index> или <target>, также поддерживают синтаксис для нескольких целей.

В синтаксисе для нескольких целей вы можете использовать список, разделённый запятыми, для выполнения запроса на нескольких ресурсах, таких как потоки данных, индексы или алиасы: test1,test2,test3. Вы также можете использовать похожие на glob символы подстановки (*) для указания ресурсов, соответствующих шаблону: test* или *test или te*t или *test*.

Вы можете исключить цели, используя символ -: test*,-test3.

Алиасы разрешаются после символов подстановки. Это может привести к тому, что запрос будет направлен на исключённый алиас. Например, если test3 является алиасом индекса, шаблон test*,-test3 всё равно указывает на индексы для test3. Чтобы этого избежать, исключите конкретные индексы для алиаса.

API для нескольких целей, которые могут указывать на индексы, поддерживают следующие параметры запроса:

ignore_unavailable
(Необязательно, булево) Если false, запрос возвращает ошибку, если он указывает на отсутствующий или закрытый индекс. По умолчанию false.
allow_no_indices
(Необязательно, булево) Если false, запрос возвращает ошибку, если любой шаблон подстановки, алиас индекса или значение _all указывают только на отсутствующие или закрытые индексы. Это поведение применяется даже если запрос указывает на другие открытые индексы. Например, запрос, указывающий на foo*,bar*, возвращает ошибку, если индекс начинается с foo, но ни один индекс не начинается с bar.
expand_wildcards

(Необязательно, строка) Тип индекса, с которым могут совпадать шаблоны подстановки. Если запрос может указывать на потоки данных, этот аргумент определяет, будут ли шаблоны подстановки совпадать с скрытыми потоками данных. Поддерживает значения, разделённые запятыми, такие как open,hidden. Допустимые значения:

all
Соответствие любому потоку данных или индексу, включая скрытые.
open
Соответствие открытым, нескрываемым индексам. Также соответствует любому нескрытому потоку данных.
closed
Соответствие закрытым, нескрываемым индексам. Также соответствует любому нескрытому потоку данных. Потоки данных не могут быть закрыты.
hidden
Соответствие скрытым потокам данных и скрытым индексам. Должно комбинироваться с open, closed или обоими.
none
Шаблоны подстановки не принимаются.

Значения параметров по умолчанию зависят от используемого API.

Некоторые API для нескольких целей, которые могут указывать на индексы, также поддерживают следующий параметр запроса:

ignore_throttled
(Необязательно, булево) Если true, конкретные, расширенные или алиасированные индексы игнорируются при заморозке. По умолчанию true.

API с одной целью, такие как API получения документа, не поддерживают синтаксис для нескольких целей.

Скрытые потоки данных и индексы

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

В качестве альтернативы, запрос шаблона индекса, начинающегося с точки, например, .watcher_hist*, по умолчанию будет соответствовать скрытым индексам. Это призвано соответствовать поведению Unix file-globbing и обеспечить более плавный переход к скрытым индексам.

Вы можете создать скрытые потоки данных, установив data_stream.hidden в значение true в соответствующем шаблоне шаблона индекса. Вы можете скрыть индексы, используя настройку индекса index.hidden.

Базовые индексы для потоков данных скрываются автоматически. Некоторые функции, такие как машинное обучение, хранят информацию в скрытых индексах.

Глобальные шаблоны индексов, которые соответствуют всем индексам, не применяются к скрытым индексам.

Системные индексы

Модули и плагины Elasticsearch могут хранить конфигурационную и служебную информацию во внутренних системных индексах. Не следует напрямую обращаться к системным индексам или изменять их, так как они содержат данные, необходимые для работы системы.

Прямой доступ к системным индексам устарел и в будущих основных версиях больше не будет разрешен.

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

Spec-Zone.ru

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