Spec-Zone.ru › Elasticsearch 7
›Elasticsearch Guide [7.17] ›REST API ›EQL API

API получения статуса асинхронного поиска EQL

Возвращает текущий статус асинхронного поиска EQL или хранимого синхронного поиска EQL без возвращения результатов. Этот API более легкий, чем API получения асинхронного поиска EQL, так как не возвращает результаты поиска, а только сообщает о статусе.

Если в Elasticsearch включены функции безопасности, доступ к API получения статуса асинхронного поиска EQL ограничен для роли monitoring_user.

GET /_eql/search/status/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

Запрос

GET /_eql/search/status/<search_id>

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

<search_id>

(Обязательно, строка) Идентификатор поиска.

Идентификатор поиска предоставляется в ответе API поиска EQL для асинхронного поиска. Идентификатор также предоставляется, если параметр запроса keep_on_completion равен true.

Тело ответа

id
(строка) Идентификатор поиска.
is_running
(boolean) Если true, запрос поиска все еще выполняется. Если false, поиск завершен.
is_partial
(boolean) Если true, ответ не содержит полные результаты поиска. Это может произойти, если поиск все еще выполняется (статус is_running равен false), или если он уже завершен (статус is_running равен true), но результаты неполные из-за ошибок или таймаутов.
start_time_in_millis
(Long) Для выполняющегося поиска показывает метку времени начала поиска EQL в миллисекундах с начала эпохи Unix.
expiration_time_in_millis
(long) Показан отметка времени истечения срока действия поиска EQL в миллисекундах с начала эпохи Unix. По достижении этого времени поиск и его результаты удаляются, даже если поиск все еще выполняется.
completion_status
(Целое число) Для завершенного поиска отображает HTTP код состояния завершенного поиска EQL.

Примеры

GET /_eql/search/status/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=?keep_alive=5d

Если поиск все еще выполняется, ответ статуса имеет следующий вид:

{
  "id" : "FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
  "is_running" : true,
  "is_partial" : true,
  "start_time_in_millis" : 1611690235000,
  "expiration_time_in_millis" : 1611690295000

}

Если поиск завершен, ответ статуса не содержит start_time_in_millis, но имеет дополнительное поле completion_status, которое показывает код состояния завершенного поиска EQL:

{
  "id" : "FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
  "is_running" : false,
  "is_partial" : false,
  "expiration_time_in_millis" : 1611690295000,
  "completion_status" : 200 
}

Указывает, что поиск EQL успешно завершен

© 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/get-async-eql-status-api.html

Spec-Zone.ru

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