ES|QL 异步查询获取 API

编辑

ES|QL 异步查询获取 API

编辑

返回 ES|QL 异步查询或存储结果的当前状态和可用结果。

resp = client.esql.async_query_get(
    id="FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
    body=None,
)
print(resp)
response = client.esql.async_query_get(
  id: 'FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM='
)
puts response
const response = await client.esql.asyncQueryGet({
  id: "FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
  body: null,
});
console.log(response);
GET /_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

请求

编辑

GET /_query/async/<query_id>

先决条件

编辑
  • 如果启用了 Elasticsearch 安全功能,只有最初提交 ES|QL 查询的用户才能使用此 API 检索结果。

路径参数

编辑
<query_id>

(必需,字符串)查询的标识符。

如果查询在等待的时间内未完成,则会在 ES|QL 异步查询 API 的响应中提供查询 ID。如果请求的 keep_on_completion 参数为 true,也会提供查询 ID。

查询参数

编辑
wait_for_completion_timeout

(可选,时间值)等待请求完成的超时时长。默认为不超时,这意味着请求会等待完整的查询结果。

如果指定此参数,并且请求在此期间完成,则会返回完整的查询结果。

如果请求在此期间未完成,则响应将返回 is_running 值为 true 且不包含任何结果。

响应主体

编辑

ES|QL 异步查询获取 API 返回与 ES|QL 查询 API 相同的响应主体。请参阅 ES|QL 查询 API 的 响应主体参数