› › ›

API поиска флота

Цель API поиска флота — предоставить API поиска, в котором поиск будет выполнен только после обработки предоставленной контрольной точки и её видимости для поиска внутри Elasticsearch.

API поиска флота предназначен для косвенного использования через сервер флота. Прямое использование не поддерживается. Elastic оставляет за собой право изменить или удалить эту функцию в будущих выпусках без предварительного уведомления.

Функциональность ожидания контрольной точки

API поиска флота поддерживает необязательный параметр wait_for_checkpoints. Этот параметр представляет собой список контрольных точек номеров последовательности. Когда этот параметр присутствует, поиск будет выполнен только на локальных фрагментах после того, как все операции до и включая предоставленную контрольную точку номера последовательности, станут видимыми для поиска. Индексированные операции становятся видимыми после обновления. Контрольные точки индексируются по фрагменту.

Если таймаут произойдёт до того, как контрольная точка будет обновлена в Elasticsearch, запрос поиска завершится по таймауту.

API поиска флота поддерживает только поиск по одному целевому объекту. Если в качестве целевого объекта указан псевдоним индекса, он должен соответствовать одному конкретному индексу.

Разрешение частичных результатов

По умолчанию API поиска Elasticsearch разрешает частичные результаты поиска. С этим API флота обычно настраивают это на false или проверяют в ответе, чтобы убедиться, что поиск на каждом фрагменте был успешным. Если эти меры предосторожности не приняты, возможно, что результаты поиска будут успешно возвращены даже в том случае, если один или несколько фрагментов завершились по таймауту.

Запрос

GET /<target>/_fleet/_fleet_search

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

<target>: (Обязательно, строка) Единственный целевой объект для поиска. Если целевой объект — псевдоним индекса, он должен соответствовать одному индексу.

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

wait_for_checkpoints: (Необязательно, список) Список контрольных точек, разделённых запятыми. В случае настройки API поиска будет выполнен только на фрагменте после того, как соответствующая контрольная точка станет видимой для поиска. По умолчанию пустой список, что заставит Elasticsearch немедленно выполнить поиск.
allow_partial_search_results: (Необязательно, логическое значение) Если true, возвращает частичные результаты при наличии таймаутов запросов фрагментов или ошибок фрагментов. Если false, возвращает ошибку без частичных результатов. По умолчанию используется настроенное значение кластера search.default_allow_partial_results, которое установлено по умолчанию как true.

© 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/fleet-search.html