获取异步 EQL 搜索 API

编辑

获取异步 EQL 搜索 API

编辑

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

resp = client.eql.get(
    id="FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
)
print(resp)
response = client.eql.get(
  id: 'FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM='
)
puts response
const response = await client.eql.get({
  id: "FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
});
console.log(response);
GET /_eql/search/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

请求

编辑

GET /_eql/search/<search_id>

先决条件

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

限制

编辑

请参阅 EQL 限制

路径参数

编辑
<search_id>

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

EQL 搜索 API 的响应中为 异步搜索 提供了搜索 ID。如果请求的 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 的 响应主体参数