Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Elasticsearch 7.6 REST API 速查表

参考来源:

Elasticsearch Reference 7.6: REST APIs https://www.elastic.co/guide/en/elasticsearch/reference/7.6/rest-apis.html

目录:

索引 API

索引 API 官方文档:doc

分类 接口功能 请求语法
索引管理 新建索引 PUT /<index>
删除索引 DELETE /<index>
查询索引 GET /<index>
是否存在索引 HEAD /<index>
关闭索引 POST /<index>/_close
打开索引 POST /<index>/_open
收缩索引 POST /<index>/_shrink/<target-index>
PUT /<index>/_shrink/<target-index>
拆分索引 POST /<index>/_split/<target-index>
PUT /<index>/_split/<target-index>
克隆索引 POST /<index>/_clone/<target-index>
PUT /<index>/_clone/<target-index>
滚动索引 POST /<alias>/_rollover/<target-index>
POST /<alias>/_rollover/
冻结索引 POST /<index>/_freeze
解冻索引 POST /<index>/_unfreeze
映射管理 设置映射 PUT /<index>/_mapping
PUT /_mapping
查询映射 GET /_mapping
GET /<index>/_mapping
查询字段的映射 GET /_mapping/field/<field>
GET /<index>/_mapping/field/<field>
是否存在 type HEAD /<index>/mapping/<type>
索引别名管理 添加索引别名 PUT /<index>/_alias/<alias>
POST /<index>/_alias/<alias>
PUT /<index>/_aliases/<alias>
POST /<index>/_aliases/<alias>
删除索引别名 DELETE /<index>/_alias/<alias>
DELETE /<index>/_aliases/<alias>
查询索引别名 GET /_alias
GET /_alias/<alias>
GET /<index>/_alias/<alias>
是否存在索引别名 HEAD /_alias/<alias>
HEAD /<index>/_alias/<alias>
更新索引别名 POST /_aliases
索引设置 更新索引设置 PUT /<index>/_settings
查询索引设置 GET /<index>/_settings
GET /<index>/_settings/<setting>
执行分析 GET /_analyze
POST /_analyze
GET /<index>/_analyze
POST /<index>/_analyze
索引模板 设置索引模板 PUT /_template/<index-template>
删除索引模板 DELETE /_template/<index-template>
查询索引模板 GET /_template/<index-template>
是否存在索引模板 HEAD /_template/<index-template>
索引监控 查询索引统计信息 GET /<index>/_stats/<index-metric>
GET /<index>/_stats
GET /_stats
查询索引分片中的 Lucene 段信息 GET /<index>/_segments
GET /_segments
查询索引恢复信息 GET /<index>/_recovery
GET /_recovery
查询索引分片存储信息 GET /<index>/_shard_stores
GET /_shard_stores
索引状态管理 清除索引缓存 POST /<index>/_cache/clear
POST /_cache/clear
refresh 索引 POST <index>/_refresh
GET <index>/_refresh
POST /_refresh
GET /_refresh
flush 索引 POST /<index>/_flush
GET /<index>/_flush
POST /_flush
GET /_flush
同步 flush 索引 POST /<index>/flush/synced
GET /<index>/flush/synced
POST /flush/synced
GET /flush/synced
强制段合并 POST /<index>/_forcemerge
POST /_forcemerge

文档 API

文档 API 官方文档:doc

分类 接口功能 请求语法
单文档 API 新建文档 PUT /<index>/_doc/<_id>
POST /<index>/_doc/
PUT /<index>/_create/<_id>
POST /<index>/_create/<_id>
查询文档 GET <index>/_doc/<_id>
HEAD <index>/_doc/<_id>
GET <index>/_source/<_id>
HEAD <index>/_source/<_id>
删除文档 DELETE /<index>/_doc/<_id>
更新文档 POST /<index>/_update/<_id>
多文档 API 批量查询文档 GET /_mget
GET /<index>/_mget
批量操作 POST /_bulk
POST /<index>/_bulk
按查询删除 POST /<index>/_delete_by_query
按查询更新 POST /<index>/_update_by_query
重建索引 POST /_reindex

搜索 API

接口 功能描述 请求语法
URI 搜索 以请求参数 q 传递搜索条件 GET /<index>/_search?q=<parameter>
请求 body 搜索 在请求体中传递搜索条件 GET /<index>/_search
{
  "query": {}
}
基于模板搜索 允许使用 mustache 模板语句预渲染搜索请求 GET _search/template
基于模板多搜索 允许执行多个模板搜索请求 GET _msearch/template
搜索分片 API 查询搜索请求执行基于哪些节点、索引和分片 GET /<index>/_search_shards
多搜索 API 通过单个 API 请求执行多个搜索 GET /<index>/_msearch
Count API 查询搜索匹配总数 GET /<index>/_count
Validate API 搜索合法性校验 GET /<index>/_validate/<query>
Explain API 用于给单个文档的查询相似度评分做解释 GET /<index>/_explain/<id>
POST /<index>/_explain/<id>
Profile API 调试工具,提供执行搜索请求的各个阶段的耗时信息 GET /<index>/_search
{
  "profile": true,
  "query": {}
}
字段功能 API 查看某一字段支持的功能,主要包括字段是否可检索以及是否可聚集等 GET /_field_caps
POST /_field_caps
GET /<index>/_field_caps
POST /<index>/_field_caps
排名评估 API 允许评估一组典型搜索查询的排名搜索结果的质量 GET /<index>/_rank_eval
POST /<index>/_rank_eval
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment