› › ›

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

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

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

resp = client.eql.get_status(
    id="FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
)
print(resp)

response = client.eql.get_status(
  id: 'FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM='
)
puts response

const response = await client.eql.getStatus({
  id: "FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
});
console.log(response);

GET /_eql/search/status/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

Запрос

GET /_eql/search/status/<search_id>

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

<search_id>

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

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

Тело ответа

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

Примеры

resp = client.eql.get_status(
    id="FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
    keep_alive="5d",
)
print(resp)

response = client.eql.get_status(
  id: 'FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=',
  keep_alive: '5d'
)
puts response

const response = await client.eql.getStatus({
  id: "FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
  keep_alive: "5d",
});
console.log(response);

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