› › ›

API Exists

Проверяет, существует ли поток данных, индекс или алиас.

resp = client.indices.exists(
    index="my-data-stream",
)
print(resp)

response = client.indices.exists(
  index: 'my-data-stream'
)
puts response

const response = await client.indices.exists({
  index: "my-data-stream",
});
console.log(response);

HEAD my-data-stream

Запрос

HEAD <target>

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

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

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

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

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

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, что означает получение информации с главного узла.

Коды ответов

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-exists.html