› › ›

API получения настроек индекса

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

GET /my-index-000001/_settings

Запрос

GET /<target>/_settings

GET /<target>/_settings/<setting>

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

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

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

<target>: (Необязательный, строка) Список потоков данных, индексов и алиасов, разделенных запятыми, используемый для ограничения запроса. Поддерживает подстановочные знаки (*). Для указания всех потоков данных и индексов опустите этот параметр или используйте * или _all.
<setting>: (Необязательный, строка) Список или выражение с подстановочными знаками имен настроек, используемый для ограничения запроса.

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

allow_no_indices

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

По умолчанию true.

expand_wildcards

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

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

По умолчанию open.

flat_settings

(Необязательный, булево) Если true, возвращает настройки в плоском формате. По умолчанию false.

include_defaults

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

ignore_unavailable

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

local

(Необязательный, булево) Если true, запрос получает информацию только с локального узла. По умолчанию false, что означает, что информация извлекается с узла-мастера.

master_timeout

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

Примеры

Несколько потоков данных и индексов

API получения настроек может использоваться для получения настроек для более чем одного потока данных или индекса одним вызовом. Чтобы получить настройки всех индексов в кластере, можно использовать _all или * для <target>. Также поддерживаются выражения с подстановочными знаками. Вот некоторые примеры:

GET /my-index-000001,my-index-000002/_settings

GET /_all/_settings

GET /log_2099_*/_settings

Фильтрация настроек по имени

Возвращаемые настройки можно отфильтровать с помощью сопоставления с подстановочными знаками следующим образом:

GET /log_2099_-*/_settings/index.number_*

© 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-get-settings.html