非同期EQL検索ステータスの取得（Get async EQL search status）

非同期EQLステータスAPIの取得

現在の非同期EQL検索または保存された同期EQL検索のステータスを結果を返さずに返します。これは、検索結果を返さず、ステータスのみを報告するため、非同期EQL検索APIの取得よりも軽量なAPIです。

Elasticsearchのセキュリティ機能が有効になっている場合、非同期EQLステータスAPIへのアクセスはmonitoring_userロールに制限されます。

Python

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

Ruby

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

Js

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

コンソール

GET /_eql/search/status/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

リクエスト

GET /_eql/search/status/<search_id>

パスパラメータ

• <search_id>
• (必須、文字列) 検索の識別子。
  検索IDは、EQL検索APIの応答で非同期検索のために提供されます。リクエストのkeep_on_completionパラメータがtrueの場合、検索IDも提供されます。

レスポンスボディ

• 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ステータスコードを示します。

例

Python

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

Ruby

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

Js

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が含まれず、完了したEQL検索のステータスコードを示す追加のcompletion_statusフィールドが含まれます:

コンソール-結果

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