获取异步 SQL 搜索 API

编辑

获取异步 SQL 搜索 API编辑

返回 异步 SQL 搜索已存储的同步 SQL 搜索 的结果。

response = client.sql.get_async(
  id: 'FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=',
  format: 'json'
)
puts response
GET _sql/async/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=?format=json

请求编辑

GET _sql/async/<search_id>

先决条件编辑

  • 如果启用了 Elasticsearch 安全功能,则只有最初提交 SQL 搜索的用户才能使用此 API 检索搜索。

限制编辑

请参阅 SQL 限制

路径参数编辑

<search_id>
(必填,字符串)搜索的标识符。

查询参数编辑

delimiter
(可选,字符串)CSV 结果的分隔符。默认为 ,。该 API 仅针对 CSV 响应支持此参数。
format
(必填,字符串)响应的格式。您必须使用此参数或 Accept HTTP 标头指定格式。如果您两者都指定,则 API 将使用此参数。有关有效值,请参阅 响应数据格式
keep_alive
(可选,时间值)搜索及其结果的保留期限。默认为原始 SQL 搜索的 keep_alive 期限。
wait_for_completion_timeout
(可选,时间值)等待完整结果的时间。默认为无超时,这意味着请求将等待完整的搜索结果。

响应正文编辑

获取异步 SQL 搜索 API 返回与 SQL 搜索 API 相同的响应正文。