› › ›

API поиска Fleet

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

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

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

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

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

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

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

По умолчанию API поиска Elasticsearch разрешит частичные результаты поиска. С этим API Fleet, часто используется настройка на 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/8.17/fleet-search.html