获取异步 EQL 搜索 API

编辑

获取异步 EQL 搜索 API编辑

返回 异步 EQL 搜索存储的同步 EQL 搜索 的当前状态和可用结果。

response = client.eql.get(
  id: 'FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM='
)
puts response
GET /_eql/search/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

请求编辑

GET /_eql/search/<search_id>

先决条件编辑

  • 如果启用了 Elasticsearch 安全功能,则只有最初提交 EQL 搜索的用户才能使用此 API 检索搜索。
  • 参见 必需字段

限制编辑

参见 EQL 限制

路径参数编辑

<search_id>

(必需,字符串) 搜索的标识符。

搜索 ID 在 EQL 搜索 API 的响应中提供,用于 异步搜索。如果请求的 keep_on_completion 参数为 true,则也会提供搜索 ID。

查询参数编辑

keep_alive

(可选,时间值) 搜索及其结果在集群上存储的期限。默认为 EQL 搜索 API 请求中设置的 keep_alive 值。

如果指定,此参数将为搜索设置一个新的 keep_alive 期限,从执行获取异步 EQL 搜索 API 请求时开始。此新期限将覆盖在 EQL 搜索 API 请求中指定的期限。

当此期限到期时,即使搜索正在进行,搜索及其结果也会被删除。

wait_for_completion_timeout

(可选,时间值) 等待请求完成的超时持续时间。默认为无超时,这意味着请求将等待完整的搜索结果。

如果指定此参数,并且请求在此期限内完成,则将返回完整的搜索结果。

如果请求在此期限内未完成,则响应将返回 is_partial 值为 true,并且不返回任何搜索结果。

响应主体编辑

异步 EQL 搜索 API 返回与 EQL 搜索 API 相同的响应主体。参见 EQL 搜索 API 的 响应主体参数