New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
« 获取异步 EQL 搜索 API ES|QL API »
Elastic 文档 ›Elasticsearch 指南 [8.17] ›REST API ›EQL API

获取异步 EQL 状态 API

编辑

获取异步 EQL 状态 API

编辑

返回异步 EQL 搜索或已存储的同步 EQL 搜索的当前状态，但不返回结果。这是一个比获取异步 EQL 搜索 API更轻量级的 API，因为它不返回搜索结果，仅报告状态。

如果启用了 Elasticsearch 安全功能，则对获取异步 EQL 状态 API 的访问权限将限制为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=
Copy as curlTry in Elastic 

请求

编辑

GET /_eql/search/status/<search_id>

路径参数

编辑
<search_id>

（必需，字符串）搜索的标识符。

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

响应主体

编辑
id
（字符串）搜索的标识符。
is_running
（布尔值）如果为true，则搜索请求仍在执行。如果为false，则搜索已完成。
is_partial
（布尔值）如果为true，则响应不包含完整的搜索结果。这可能是因为搜索仍在运行（is_running 状态为false），或者因为搜索已完成（is_running 状态为true）并且由于失败或超时导致结果不完整。
start_time_in_millis
（Long）对于正在运行的搜索，显示 EQL 搜索开始的时间戳，以自 Unix 纪元以来的毫秒数表示。
expiration_time_in_millis
（long）显示 EQL 搜索过期的时时间戳，以自 Unix 纪元以来的毫秒数表示。达到此时间后，即使搜索仍在进行中，也会删除搜索及其结果。
completion_status
（Integer）对于已完成的搜索，显示已完成搜索的 HTTP 状态代码。

示例

编辑
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
Copy as curlTry in Elastic 

如果搜索仍在运行，则状态响应具有以下形式

{
  "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 搜索已成功完成
« 获取异步 EQL 搜索 API ES|QL API »

On this page

Was this helpful?
Feedback