Search | Elasticsearch API documentation (v8)

Search | Elasticsearch API documentation (v8)

Power insights and outcomes with The Elastic Search AI Platform. See into your data and find answers that matter with enterprise solutions designed to help you accelerate time to insight. Try Elastic ...

访问网站
我的收藏183 次访问更新于 25 days ago反馈
Search | Elasticsearch API documentation (v8) screenshot

详细介绍

Elasticsearch API 文档(v8)— Search 操作

Elastic 标志

简介

本页面为 Elasticsearch v8 官方 API 文档中 Search(搜索) 主题下的接口说明,由 Bump.sh 提供文档托管。其中详细描述了包括滚动搜索(scrolling search)、异步搜索、向量搜索、搜索模板等在内的多种搜索相关操作。本文重点提取并整理文档中关于“运行滚动搜索(Run a scrolling search)”这一操作的说明。

该文档站点涵盖 Elasticsearch 的 Autoscaling、CAT、Cluster、Document、EQL、Machine learning、Search、SQL 等众多 API 主题,并提供鉴权方式、路径参数、查询参数、请求体及响应结构等完整参考。

主要功能

在 Search 主题下,v8 版本提供的主要操作包括:

  • 获取异步搜索结果(GET)
  • 删除异步搜索(DELETE)
  • 获取异步搜索状态(GET)
  • 运行异步搜索(POST)
  • 运行滚动搜索(POST /_search/scroll/{scroll_id})
  • 清除滚动搜索(DELETE)
  • 关闭时间点(PIT,DELETE)
  • 统计搜索结果数(GET)
  • 解释文档匹配结果(POST)
  • 获取字段能力(POST)
  • 运行 kNN 搜索(POST)
  • 运行多个搜索 / 多个模板搜索(POST)
  • 打开时间点(POST)
  • 评估排序搜索结果(POST)
  • 渲染搜索模板(POST)
  • 运行搜索(POST)
  • 搜索矢量切片(GET)
  • 获取搜索分片(POST)
  • 使用搜索模板运行搜索(POST)
  • 获取索引中的词项(POST)

运行滚动搜索(Run a scrolling search)

  • API 路径POST /_search/scroll/{scroll_id}(另有 GET /_search/scrollPOST /_search/scrollGET /_search/scroll/{scroll_id}
  • 稳定性:Generally available(正式可用)
  • 鉴权方式:Api key auth、Basic auth、Bearer auth
  • 作用:滚动 API 用于从单个滚动搜索请求中获取大量结果集。需先提交带 scroll 查询参数的搜索 API 请求以获取滚动 ID(_scroll_id),随后使用该 ID 调用滚动 API 获取下一批结果。
  • 重要说明
    • 滚动 API 不再推荐用于深度分页;如需在翻页超过 10,000 条命中时保留索引状态,应使用带有时间点(PIT)的 search_after 参数。
    • 滚动搜索结果反映初始搜索请求时索引的状态,后续索引或文档变更不影响已开启的滚动请求。
    • 若启用 Elasticsearch 安全特性,特定滚动 ID 的结果仅对提交搜索的用户或 API Key 可见。
  • 必需授权:索引权限 read
  • 路径参数scroll_id(STRING,必填,已弃用)——滚动 ID
  • 查询参数scroll(STRING,保留搜索上下文的时间)、scroll_id(STRING,已弃用)、rest_total_hits_as_int(BOOLEAN,控制 hit.total 返回格式)
  • 请求体:可包含 scroll(STRING)与 scroll_id(STRING,必填)
  • 响应(200):包含 tooktimed_out_shardshits_scroll_id 等字段;其中 _scroll_id 仅在请求指定了 scroll 参数时返回。

适用场景

  • 需要查阅 Elasticsearch v8 搜索相关 API 的请求方式、参数及响应结构的开发者和运维人员。
  • 在实现大量数据导出或批处理时,需了解传统滚动搜索用法及其替代方案(PIT + search_after)的工程师。
  • 对接 Elasticsearch 搜索接口、编写客户端代码或调试请求时,作为权威的 API 参考文档。