Easysearch REST API #

async_search.delete #

删除指定的异步搜索请求及其结果。

DELETE _async_search/{id}

URL 参数 #

async_search.get #

获取异步搜索请求的当前状态和可用结果。

GET _async_search/{id}

URL 参数 #

async_search.stats #

获取集群中异步搜索的统计信息。

GET _async_search/stats

URL 参数 #

async_search.submit #

提交一个异步搜索请求。返回一个 ID，可用于后续获取结果。

POST _async_search
POST {index}/_async_search

URL 参数 #

HTTP 请求体 #

标准搜索请求体，包含 query、aggregations 等。

bulk #

在单个请求中执行多个索引、更新和/或删除操作。

POST _bulk
PUT _bulk

POST {index}/_bulk
PUT {index}/_bulk

POST {index}/{type}/_bulk
PUT {index}/{type}/_bulk

HTTP 请求体 #

操作定义和数据（action-data 对），以换行符分隔。

必需：是

URL 参数 #

cat.aliases #

显示当前已配置的索引别名信息，包括过滤器和路由信息。

GET _cat/aliases

GET _cat/aliases/{name}

URL 参数 #

cat.allocation #

显示每个数据节点的分片分配数量和磁盘使用情况快照。

GET _cat/allocation

GET _cat/allocation/{node_id}

URL 参数 #

cat.count #

快速获取整个集群或单个索引的文档数量。

GET _cat/count

GET _cat/count/{index}

URL 参数 #

cat.fielddata #

显示集群中每个数据节点上 fielddata 当前使用的堆内存大小。

GET _cat/fielddata

GET _cat/fielddata/{fields}

URL 参数 #

cat.health #

返回集群健康状态的简要信息。

GET _cat/health

URL 参数 #

cat.help #

返回 Cat API 的帮助信息。

GET _cat

URL 参数 #

cat.indices #

返回索引相关信息：主分片和副本数量、文档数量、磁盘大小等。

GET _cat/indices

GET _cat/indices/{index}

URL 参数 #

cat.master #

返回主节点的信息。

GET _cat/master

URL 参数 #

cat.nodeattrs #

返回自定义节点属性信息。

GET _cat/nodeattrs

URL 参数 #

cat.nodes #

返回集群节点的基本性能统计信息。

GET _cat/nodes

URL 参数 #

cat.pending_tasks #

返回集群待处理任务的简要信息。

GET _cat/pending_tasks

URL 参数 #

cat.plugins #

返回各节点已安装插件的信息。

GET _cat/plugins

URL 参数 #

cat.recovery #

返回正在进行和已完成的分片恢复信息。

GET _cat/recovery

GET _cat/recovery/{index}

URL 参数 #

cat.repositories #

返回集群中已注册的快照仓库信息。

GET _cat/repositories

URL 参数 #

cat.segments #

提供索引分片中段（segment）的底层信息。

GET _cat/segments

GET _cat/segments/{index}

URL 参数 #

cat.shards #

返回节点上分片分配的详细视图。

GET _cat/shards

GET _cat/shards/{index}

URL 参数 #

cat.snapshots #

返回特定仓库中的所有快照。

GET _cat/snapshots

GET _cat/snapshots/{repository}

URL 参数 #

cat.tasks #

返回集群中一个或多个节点上当前正在执行的任务信息。

GET _cat/tasks

URL 参数 #

cat.templates #

返回已存在的索引模板信息。

GET _cat/templates

GET _cat/templates/{name}

URL 参数 #

cat.thread_pool #

返回各节点的集群范围线程池统计信息。 默认返回所有线程池的活跃（active）、队列（queue）和拒绝（rejected）统计信息。

GET _cat/thread_pool

GET _cat/thread_pool/{thread_pool_patterns}

URL 参数 #

clear_scroll #

显式清除搜索滚动上下文，释放相关资源。

DELETE _search/scroll

DELETE _search/scroll/{scroll_id}

HTTP 请求体 #

如未通过 scroll_id 参数指定，则为要清除的滚动 ID 的逗号分隔列表

cluster.allocation_explain #

解释集群中分片分配的原因。

GET _cluster/allocation/explain
POST _cluster/allocation/explain

HTTP 请求体 #

需要解释的索引、分片和主分片标识。为空表示’解释第一个未分配的分片'

URL 参数 #

cluster.delete_component_template #

删除组件模板。

DELETE _component_template/{name}

URL 参数 #

cluster.delete_voting_config_exclusions #

清除集群投票配置排除项。

DELETE _cluster/voting_config_exclusions

URL 参数 #

cluster.exists_component_template #

检查指定组件模板是否存在。

HEAD _component_template/{name}

URL 参数 #

cluster.get_component_template #

获取一个或多个组件模板。

GET _component_template

GET _component_template/{name}

URL 参数 #

cluster.get_settings #

返回集群级别的设置。

GET _cluster/settings

URL 参数 #

cluster.health #

返回集群健康状态的基本信息。

GET _cluster/health

GET _cluster/health/{index}

URL 参数 #

cluster.pending_tasks #

返回所有尚未执行的集群级变更（例如创建索引、更新映射、 分配或失败分片）的列表。

GET _cluster/pending_tasks

URL 参数 #

cluster.post_voting_config_exclusions #

通过节点 ID 或名称更新集群投票配置排除列表。

POST _cluster/voting_config_exclusions

URL 参数 #

cluster.put_component_template #

创建或更新组件模板。

PUT _component_template/{name}
POST _component_template/{name}

HTTP 请求体 #

模板定义

必需：是

URL 参数 #

cluster.put_settings #

更新集群级别的设置。

PUT _cluster/settings

HTTP 请求体 #

要更新的设置。可以是 transient（临时）或 persistent（持久化，重启后保留）。

必需：是

URL 参数 #

cluster.remote_info #

返回所有已配置的远程集群信息。

GET _remote/info

cluster.reroute #

允许手动更改集群中各分片的分配。

POST _cluster/reroute

HTTP 请求体 #

要执行的 commands 定义（move、cancel、allocate）

URL 参数 #

cluster.state #

返回集群状态的详细信息。

GET _cluster/state

GET _cluster/state/{metric}

GET _cluster/state/{metric}/{index}

URL 参数 #

cluster.stats #

返回集群的高级统计概览。

GET _cluster/stats

GET _cluster/stats/nodes/{node_id}

URL 参数 #

count #

返回匹配查询的文档数量。

POST _count
GET _count

POST {index}/_count
GET {index}/_count

POST {index}/{type}/_count
GET {index}/{type}/_count

HTTP 请求体 #

使用 Query DSL 指定的查询条件，用于限制结果（可选）

URL 参数 #

create #

在索引中创建新文档。

当索引中已存在相同 ID 的文档时返回 409 错误。

PUT {index}/_create/{id}
POST {index}/_create/{id}

PUT {index}/{type}/{id}/_create
POST {index}/{type}/{id}/_create

HTTP 请求体 #

The document

必需：是

URL 参数 #

create_pit #

创建 Point-In-Time（PIT）上下文，为后续搜索请求提供一致的数据快照视图。

POST {index}/_pit

URL 参数 #

dangling_indices.delete_dangling_index #

删除指定的悬空索引

DELETE _dangling/{index_uuid}

URL 参数 #

dangling_indices.import_dangling_index #

导入指定的悬空索引

POST _dangling/{index_uuid}

URL 参数 #

dangling_indices.list_dangling_indices #

返回所有悬空索引。

GET _dangling

delete #

从索引中删除文档。

DELETE {index}/_doc/{id}

DELETE {index}/{type}/{id}

URL 参数 #

delete_by_query #

删除匹配查询的文档。

POST {index}/_delete_by_query

POST {index}/{type}/_delete_by_query

HTTP 请求体 #

使用 Query DSL 的搜索定义

必需：是

URL 参数 #

delete_by_query_rethrottle #

修改 delete-by-query 操作的每秒请求数。

POST _delete_by_query/{task_id}/_rethrottle

URL 参数 #

delete_pit #

删除一个或多个 Point-In-Time（PIT）上下文。支持删除指定的 PIT（通过请求体）或一次性删除所有 PIT。

DELETE _pit

DELETE _pit/_all

HTTP 请求体 #

包含要删除的 PIT ID 列表的 JSON 对象。使用 _pit/_all 路由时无需请求体。

delete_script #

删除存储的脚本。

DELETE _scripts/{id}

URL 参数 #

exists #

检查指定 ID 的文档是否存在于索引中。

HEAD {index}/_doc/{id}

HEAD {index}/{type}/{id}

URL 参数 #

exists_source #

检查指定 ID 文档的 _source 是否存在于索引中。

HEAD {index}/_source/{id}

HEAD {index}/{type}/{id}/_source

URL 参数 #

explain #

解释某个文档为什么匹配（或不匹配）某个查询。

GET {index}/_explain/{id}
POST {index}/_explain/{id}

GET {index}/{type}/{id}/_explain
POST {index}/{type}/{id}/_explain

HTTP 请求体 #

使用 Query DSL 的查询定义

URL 参数 #

field_caps #

返回多个索引中各字段的能力信息（可搜索、可聚合等）。

GET _field_caps
POST _field_caps

GET {index}/_field_caps
POST {index}/_field_caps

HTTP 请求体 #

使用 Query DSL 指定的索引过滤器

URL 参数 #

get #

获取指定文档。

GET {index}/_doc/{id}

GET {index}/{type}/{id}

URL 参数 #

get_all_pits #

获取集群中所有节点上的所有活跃 Point-In-Time（PIT）上下文。

GET _pit/_all

此 API 无需额外参数。响应包含一个 pits 数组，列出所有活跃的 PIT 及其详细信息。

get_script #

获取存储的脚本。

GET _scripts/{id}

URL 参数 #

get_script_context #

返回所有可用的脚本上下文。

GET _script_context

get_script_languages #

返回可用的脚本类型、语言和上下文。

GET _script_language

get_source #

获取指定文档的 _source 内容。

GET {index}/_source/{id}

GET {index}/{type}/{id}/_source

URL 参数 #

index #

在索引中创建或更新文档。

PUT {index}/_doc/{id}
POST {index}/_doc/{id}

POST {index}/_doc

POST {index}/{type}

PUT {index}/{type}/{id}
POST {index}/{type}/{id}

HTTP 请求体 #

The document

必需：是

URL 参数 #

ik.reload #

在集群的所有节点上重新加载 IK 分词器词典。可以指定从特定索引加载词典数据。

POST _ik/_reload

HTTP 请求体 #

ilm.add_policy #

为一个或多个索引添加 ISM（索引状态管理）策略。

POST _ilm/add
POST _ilm/add/{index}

URL 参数 #

HTTP 请求体 #

ilm.change_policy #

更改已应用于一个或多个索引的 ISM 策略。

POST _ilm/change_policy
POST _ilm/change_policy/{index}

URL 参数 #

HTTP 请求体 #

变更策略配置，包含新的 policy_id、状态过滤器等。

ilm.delete_policy #

删除指定的 ISM 策略。

DELETE _ilm/policy/{policyID}

URL 参数 #

ilm.explain #

获取一个或多个索引的 ISM 策略执行状态和详情。

GET _ilm/explain
GET _ilm/explain/{index}

URL 参数 #

ilm.get_policy #

获取一个或多个 ISM 策略的定义。

GET _ilm/policy
GET _ilm/policy/{policyID}
HEAD _ilm/policy/{policyID}

URL 参数 #

ilm.put_policy #

创建或更新一个 ISM 策略。

PUT _ilm/policy/{policyID}

URL 参数 #

HTTP 请求体 #

ISM 策略定义，包含策略描述、状态列表、转换条件、操作配置等。

ilm.remove_policy #

从一个或多个索引上移除 ISM 策略。

POST _ilm/remove
POST _ilm/remove/{index}

URL 参数 #

ilm.retry #

重试因错误而失败的 ISM 策略执行。

POST _ilm/retry
POST _ilm/retry/{index}

URL 参数 #

HTTP 请求体 #

indices.add_block #

为索引添加操作限制块。

PUT {index}/_block/{block}

URL 参数 #

indices.analyze #

对文本执行分析（分词）处理，返回分词结果。

GET _analyze
POST _analyze

GET {index}/_analyze
POST {index}/_analyze

HTTP 请求体 #

定义分析器/分词器参数以及需要进行分析的文本

URL 参数 #

indices.clear_cache #

清除一个或多个索引的全部或指定类型的缓存。

POST _cache/clear

POST {index}/_cache/clear

URL 参数 #

indices.clone #

克隆索引

PUT {index}/_clone/{target}
POST {index}/_clone/{target}

HTTP 请求体 #

目标索引的配置（settings 和 aliases）

URL 参数 #

indices.close #

关闭索引。

POST {index}/_close

URL 参数 #

indices.create #

创建索引，可指定设置和映射。

PUT {index}

HTTP 请求体 #

索引的配置（settings 和 mappings）

URL 参数 #

indices.create_data_stream #

创建或更新数据流。

PUT _data_stream/{name}

HTTP 请求体 #

数据流定义。

indices.data_streams_stats #

返回数据流的操作统计信息。

GET _data_stream/_stats

GET _data_stream/{name}/_stats

indices.delete_data_stream #

删除数据流。

DELETE _data_stream/{name}

indices.get_data_stream #

获取数据流信息。

GET _data_stream

GET _data_stream/{name}

indices.delete #

删除索引。

DELETE {index}

URL 参数 #

indices.delete_alias #

删除索引别名。

DELETE {index}/_alias/{name}

DELETE {index}/_aliases/{name}

URL 参数 #

indices.delete_index_template #

删除索引模板。

DELETE _index_template/{name}

URL 参数 #

indices.delete_template #

删除索引模板。

DELETE _template/{name}

URL 参数 #

indices.disk_usage #

分析一个或多个索引的磁盘空间使用情况，按字段级别提供详细的空间占用报告。此操作资源开销较大，需显式设置 run_expensive_tasks=true。

POST {index}/_disk_usage

URL 参数 #

indices.exists #

检查指定索引是否存在。

HEAD {index}

URL 参数 #

indices.exists_alias #

检查指定索引别名是否存在。

HEAD _alias/{name}

HEAD {index}/_alias/{name}

URL 参数 #

indices.exists_index_template #

检查指定索引模板是否存在。

HEAD _index_template/{name}

URL 参数 #

indices.exists_template #

检查指定索引模板是否存在。

HEAD _template/{name}

URL 参数 #

indices.exists_type #

检查指定文档类型是否存在（已废弃）。

HEAD {index}/_mapping/{type}

URL 参数 #

indices.field_usage_stats #

返回一个或多个索引的字段使用统计信息，显示各字段被查询和使用的情况。

GET {index}/_field_usage_stats

URL 参数 #

indices.flush #

对一个或多个索引执行 flush 操作，将内存中的数据持久化到磁盘。

POST _flush
GET _flush

POST {index}/_flush
GET {index}/_flush

URL 参数 #

indices.flush_synced #

对一个或多个索引执行同步 flush 操作。同步 flush 已废弃，请使用 flush 代替。

POST _flush/synced
GET _flush/synced

POST {index}/_flush/synced
GET {index}/_flush/synced

URL 参数 #

indices.forcemerge #

对一个或多个索引执行强制合并操作。

POST _forcemerge

POST {index}/_forcemerge

URL 参数 #

indices.get #

返回一个或多个索引的信息。

GET {index}

URL 参数 #

indices.get_alias #

获取索引别名信息。

GET _alias

GET _alias/{name}

GET {index}/_alias/{name}

GET {index}/_alias

URL 参数 #

indices.get_field_mapping #

获取一个或多个字段的映射信息。

GET _mapping/field/{fields}

GET {index}/_mapping/field/{fields}

GET _mapping/{type}/field/{fields}

GET {index}/_mapping/{type}/field/{fields}

URL 参数 #

indices.get_index_template #

获取索引模板。

GET _index_template

GET _index_template/{name}

URL 参数 #

indices.get_mapping #

获取一个或多个索引的映射信息。

GET _mapping

GET {index}/_mapping

GET _mapping/{type}

GET {index}/_mapping/{type}

URL 参数 #

indices.get_settings #

获取一个或多个索引的设置信息。

GET _settings

GET {index}/_settings

GET {index}/_settings/{name}

GET _settings/{name}

URL 参数 #

indices.get_template #

获取索引模板。

GET _template

GET _template/{name}

URL 参数 #

indices.get_upgrade #

_upgrade API 已不再有用，将被移除。

GET _upgrade

GET {index}/_upgrade

URL 参数 #

indices.open #

打开已关闭的索引。

POST {index}/_open

URL 参数 #

indices.put_alias #

创建或更新索引别名。

PUT {index}/_alias/{name}
POST {index}/_alias/{name}

PUT {index}/_aliases/{name}
POST {index}/_aliases/{name}

HTTP 请求体 #

别名的设置，例如 routing 或 filter

必需：否

URL 参数 #

indices.put_index_template #

创建或更新索引模板。

PUT _index_template/{name}
POST _index_template/{name}

HTTP 请求体 #

模板定义

必需：是

URL 参数 #

indices.put_mapping #

更新索引的映射。

PUT {index}/_mapping
POST {index}/_mapping

PUT {index}/{type}/_mapping
POST {index}/{type}/_mapping

PUT {index}/_mapping/{type}
POST {index}/_mapping/{type}

PUT {index}/{type}/_mappings
POST {index}/{type}/_mappings

PUT {index}/_mappings/{type}
POST {index}/_mappings/{type}

PUT _mappings/{type}
POST _mappings/{type}

PUT {index}/_mappings
POST {index}/_mappings

PUT _mapping/{type}
POST _mapping/{type}

HTTP 请求体 #

映射定义

必需：是

URL 参数 #

indices.put_settings #

更新索引的设置。

PUT _settings

PUT {index}/_settings

HTTP 请求体 #

要更新的索引设置

必需：是

URL 参数 #

indices.put_template #

创建或更新索引模板。

PUT _template/{name}
POST _template/{name}

HTTP 请求体 #

模板定义

必需：是

URL 参数 #

indices.recovery #

返回正在进行的分片恢复信息。

GET _recovery

GET {index}/_recovery

URL 参数 #

indices.refresh #

对一个或多个索引执行刷新操作，使最近的变更对搜索可见。

POST _refresh
GET _refresh

POST {index}/_refresh
GET {index}/_refresh

URL 参数 #

indices.refresh_search_analyzers #

刷新一个或多个索引的搜索分析器，使分析器配置更改生效，无需关闭和重新打开索引。

POST _refresh_search_analyzers
POST _refresh_search_analyzers/{index}

URL 参数 #

indices.reload #

重新加载一个或多个索引的 fast-terms 数据。

GET {index}/_reload
POST {index}/_reload

URL 参数 #

indices.resolve_index #

返回所有匹配的索引、别名和数据流的信息

GET _resolve/index/{name}

URL 参数 #

indices.rollover #

当现有索引被认为太大或太旧时，更新别名以指向新索引。

POST {alias}/_rollover

POST {alias}/_rollover/{new_index}

HTTP 请求体 #

执行滚动更新（rollover）需要满足的条件

URL 参数 #

indices.segments #

返回 Lucene 索引中段的底层信息。

GET _segments

GET {index}/_segments

URL 参数 #

indices.shard_stores #

返回索引分片副本的存储信息。

GET _shard_stores

GET {index}/_shard_stores

URL 参数 #

indices.shrink #

将现有索引收缩为具有更少主分片的新索引。

PUT {index}/_shrink/{target}
POST {index}/_shrink/{target}

HTTP 请求体 #

目标索引的配置（settings 和 aliases）

URL 参数 #

indices.simulate_index_template #

模拟给定索引名称与系统中索引模板的匹配结果。

POST _index_template/_simulate_index/{name}

HTTP 请求体 #

新的索引模板定义，将包含在模拟中，如同它已存在于系统中

必需：否

URL 参数 #

indices.simulate_template #

模拟解析给定的模板名称或模板体。

POST _index_template/_simulate

POST _index_template/_simulate/{name}

HTTP 请求体 #

如未指定索引模板名称，则为要模拟的新索引模板定义

必需：否

URL 参数 #

indices.split #

将现有索引拆分为具有更多主分片的新索引。

PUT {index}/_split/{target}
POST {index}/_split/{target}

HTTP 请求体 #

目标索引的配置（settings 和 aliases）

URL 参数 #

indices.stats #

返回索引上发生的操作统计信息。

GET _stats

GET _stats/{metric}

GET {index}/_stats

GET {index}/_stats/{metric}

URL 参数 #

indices.update_aliases #

批量更新索引别名。

POST _aliases

HTTP 请求体 #

要执行的 actions 定义

必需：是

URL 参数 #

indices.upgrade #

_upgrade API 已不再有用，将被移除。

POST _upgrade

POST {index}/_upgrade

URL 参数 #

indices.validate_query #

验证查询 DSL 的正确性，而不实际执行查询。

GET _validate/query
POST _validate/query

GET {index}/_validate/query
POST {index}/_validate/query

GET {index}/{type}/_validate/query
POST {index}/{type}/_validate/query

HTTP 请求体 #

使用 Query DSL 指定的查询定义

URL 参数 #

info #

返回集群的基本信息。

GET /

ingest.delete_pipeline #

删除 Pipeline。

DELETE _ingest/pipeline/{id}

URL 参数 #

ingest.get_pipeline #

获取 Pipeline 信息。

GET _ingest/pipeline

GET _ingest/pipeline/{id}

URL 参数 #

ingest.processor_grok #

返回内置 Grok 模式列表。

GET _ingest/processor/grok

ingest.put_pipeline #

创建或更新 Pipeline。

PUT _ingest/pipeline/{id}

HTTP 请求体 #

摄取管道定义

必需：是

URL 参数 #

ingest.simulate #

使用示例文档模拟 Pipeline 的执行效果。

GET _ingest/pipeline/_simulate
POST _ingest/pipeline/_simulate

GET _ingest/pipeline/{id}/_simulate
POST _ingest/pipeline/{id}/_simulate

HTTP 请求体 #

模拟定义

必需：是

URL 参数 #

license #

管理 Easysearch 许可证。支持查看当前许可证信息、应用新许可证和删除许可证。

GET _license/info

POST _license/apply

DELETE _license

HTTP 请求体（仅 POST） #

包含 license 字段的 JSON 对象，值为许可证字符串。

必需：是（仅 POST）

URL 参数（仅 POST 和 DELETE） #

match_rules.compile #

编译指定规则仓库中的规则。编译后的规则用于 Ingest Pipeline 写入阶段的规则匹配（如 check_match_rules 处理器）。

POST _match_rules/{repo_id}/_compile

URL 参数 #

HTTP 请求体 #

说明：请求体是必需的，至少传空对象 {}。

match_rules.delete #

删除指定的规则仓库。

DELETE _match_rules/{repo_id}

URL 参数 #

match_rules.import #

批量导入规则到规则仓库。

POST _match_rules/_import
PUT _match_rules/_import
POST _match_rules/{repo_id}/_import
PUT _match_rules/{repo_id}/_import

URL 参数 #

HTTP 请求体 #

规则导入数据，包含规则定义列表。

语义说明：

• POST /_match_rules/{repo_id}/_import：覆盖导入（upsert）
• PUT /_match_rules/{repo_id}/_import：追加导入（append）
• POST /_match_rules/_import：自动生成 repo_id 后覆盖导入
• PUT /_match_rules/_import：自动生成 repo_id 后按追加语义导入（通常表现为新建规则库）

mget #

在单个请求中获取多个文档。

GET _mget
POST _mget

GET {index}/_mget
POST {index}/_mget

GET {index}/{type}/_mget
POST {index}/{type}/_mget

HTTP 请求体 #

文档标识符；可以是 docs（包含完整文档信息）或 ids（当 URL 中提供了索引和类型时）。

必需：是

URL 参数 #

msearch #

在单个请求中执行多个搜索操作。

GET _msearch
POST _msearch

GET {index}/_msearch
POST {index}/_msearch

GET {index}/{type}/_msearch
POST {index}/{type}/_msearch

HTTP 请求体 #

请求定义（元数据-搜索请求定义对），以换行符分隔

必需：是

URL 参数 #

msearch_template #

在单个请求中使用模板执行多个搜索操作。

GET _msearch/template
POST _msearch/template

GET {index}/_msearch/template
POST {index}/_msearch/template

GET {index}/{type}/_msearch/template
POST {index}/{type}/_msearch/template

HTTP 请求体 #

请求定义（元数据-搜索请求定义对），以换行符分隔

必需：是

URL 参数 #

mtermvectors #

在单个请求中获取多个文档的词项向量。

GET _mtermvectors
POST _mtermvectors

GET {index}/_mtermvectors
POST {index}/_mtermvectors

GET {index}/{type}/_mtermvectors
POST {index}/{type}/_mtermvectors

HTTP 请求体 #

在此定义 ID、文档、参数或每个文档的参数列表。至少需要提供文档 ID 列表。详见文档。

必需：否

URL 参数 #

nodes.hot_threads #

返回集群中各节点的热线程信息。

GET _nodes/hot_threads

GET _nodes/{node_id}/hot_threads

GET _cluster/nodes/hotthreads

GET _cluster/nodes/{node_id}/hotthreads

GET _nodes/hotthreads

GET _nodes/{node_id}/hotthreads

GET _cluster/nodes/hot_threads

GET _cluster/nodes/{node_id}/hot_threads

URL 参数 #

nodes.info #

返回集群中节点的信息。

GET _nodes

GET _nodes/{node_id}

GET _nodes/{metric}

GET _nodes/{node_id}/{metric}

URL 参数 #

nodes.reload_secure_settings #

重新加载安全设置（keystore）。

POST _nodes/reload_secure_settings

POST _nodes/{node_id}/reload_secure_settings

HTTP 请求体 #

包含 Easysearch 密钥库密码的对象

必需：否

URL 参数 #

nodes.stats #

返回集群节点的统计信息。

GET _nodes/stats

GET _nodes/{node_id}/stats

GET _nodes/stats/{metric}

GET _nodes/{node_id}/stats/{metric}

GET _nodes/stats/{metric}/{index_metric}

GET _nodes/{node_id}/stats/{metric}/{index_metric}

URL 参数 #

nodes.usage #

返回节点上 REST 操作使用情况的低级信息。

GET _nodes/usage

GET _nodes/{node_id}/usage

GET _nodes/usage/{metric}

GET _nodes/{node_id}/usage/{metric}

URL 参数 #

ping #

检查集群是否正在运行。

HEAD

put_script #

创建或更新存储的脚本。

PUT _scripts/{id}
POST _scripts/{id}

PUT _scripts/{id}/{context}
POST _scripts/{id}/{context}

HTTP 请求体 #

The document

必需：是

URL 参数 #

rank_eval #

允许对一组典型搜索查询评估排名搜索结果的质量

GET _rank_eval
POST _rank_eval

GET {index}/_rank_eval
POST {index}/_rank_eval

HTTP 请求体 #

排名评估搜索定义，包括搜索请求、文档评分和排名指标定义。

必需：是

URL 参数 #

reindex #

允许将文档从一个索引复制到另一个索引，可选地过滤源文档 （通过查询过滤）、更改目标索引设置，或从远程集群 获取文档。

POST _reindex

HTTP 请求体 #

使用 Query DSL 的搜索定义 and the prototype for the index request.

必需：是

URL 参数 #

reindex_rethrottle #

修改 reindex 操作的每秒请求数。

POST _reindex/{task_id}/_rethrottle

URL 参数 #

rollup.create #

创建一个 rollup 任务。Rollup 任务可以将历史数据按时间维度聚合压缩，减少存储开销。

PUT _rollup/jobs/{rollupID}

URL 参数 #

HTTP 请求体 #

Rollup 任务配置，包含源索引、目标索引、聚合维度、调度策略等定义。

rollup.delete #

删除指定的 rollup 任务。

DELETE _rollup/jobs/{rollupID}

URL 参数 #

rollup.explain #

查看一个或多个 rollup 任务的运行详情和执行状态。

GET _rollup/jobs/{rollupID}/_explain

URL 参数 #

rollup.get #

获取 rollup 任务的定义信息。可以获取单个任务或列出所有任务。

GET _rollup/jobs
GET _rollup/jobs/{rollupID}
HEAD _rollup/jobs/{rollupID}

URL 参数 #

rollup.search #

搜索包含 rollup 数据的索引。当索引配置了 rollup 任务时，搜索请求会自动合并原始数据与 rollup 聚合数据。此 API 是对标准 _search 的增强，通过 enable_rollup 参数控制是否启用 rollup 搜索。

GET {index}/_search
POST {index}/_search

URL 参数 #

HTTP 请求体 #

标准搜索请求体。当启用 rollup 搜索时，查询必须包含聚合（aggregations），且只能指定单个索引，size 必须为 0。

rollup.start #

启动已停止的 rollup 任务。

POST _rollup/jobs/{rollupID}/_start

URL 参数 #

rollup.stop #

停止正在运行的 rollup 任务。

POST _rollup/jobs/{rollupID}/_stop

URL 参数 #

rollup.update #

更新已有的 rollup 任务的部分配置（如执行间隔、分页大小等）。

POST _rollup/jobs/{rollupID}

URL 参数 #

HTTP 请求体 #

render_search_template #

使用 Mustache 模板语言预渲染搜索定义。

GET _render/template
POST _render/template

GET _render/template/{id}
POST _render/template/{id}

HTTP 请求体 #

搜索定义模板及其参数

scripts_painless_execute #

执行任意 Painless 脚本并返回结果。

GET _scripts/painless/_execute
POST _scripts/painless/_execute

HTTP 请求体 #

要执行的脚本

scroll #

通过滚动方式从单次搜索请求中获取大量结果。

GET _search/scroll
POST _search/scroll

GET _search/scroll/{scroll_id}
POST _search/scroll/{scroll_id}

HTTP 请求体 #

如未通过 URL 或查询参数传递的滚动 ID。

URL 参数 #

search #

执行搜索查询，返回匹配的文档。

GET _search
POST _search

GET {index}/_search
POST {index}/_search

GET {index}/{type}/_search
POST {index}/{type}/_search

HTTP 请求体 #

使用 Query DSL 的搜索定义

URL 参数 #

search_pipeline.delete #

删除指定的搜索管道。

DELETE _search/pipeline/{id}

URL 参数 #

search_pipeline.get #

获取一个或多个搜索管道的定义。不指定 ID 时返回所有管道。

GET _search/pipeline

GET _search/pipeline/{id}

URL 参数 #

search_pipeline.put #

创建或更新搜索管道。如果管道的请求处理器中包含 semantic_query_enricher，其 api_key 字段会在存储前自动加密。

PUT _search/pipeline/{id}

HTTP 请求体 #

搜索管道的配置定义（包括处理器等）。

必需：是

URL 参数 #

search_shards #

返回搜索请求将要执行的索引和分片信息。

GET _search_shards
POST _search_shards

GET {index}/_search_shards
POST {index}/_search_shards

URL 参数 #

search_template #

使用 Mustache 模板语言预渲染搜索定义。

GET _search/template
POST _search/template

GET {index}/_search/template
POST {index}/_search/template

GET {index}/{type}/_search/template
POST {index}/{type}/_search/template

HTTP 请求体 #

搜索定义模板及其参数

必需：是

URL 参数 #

security.account #

获取或更新当前登录用户的账户信息，包括密码修改。

GET _security/account
PUT _security/account

HTTP 请求体（PUT） #

用户账户更新信息，如新密码等。

security.authinfo #

获取当前经过身份验证的用户信息，包括角色、后端角色等。

GET _security/authinfo
POST _security/authinfo

security.authtoken #

生成身份验证令牌。

POST _security/authtoken

HTTP 请求体 #

令牌请求参数。

security.cache #

刷新安全模块缓存，使安全配置更改立即生效。

DELETE _security/cache
GET _security/cache
PUT _security/cache
POST _security/cache

security.config #

获取或更新安全模块的全局配置。

GET _security/securityconfig/
PUT _security/securityconfig/{name}
PATCH _security/securityconfig/

URL 参数 #

HTTP 请求体（PUT/PATCH） #

安全配置内容。

security.nodesdn #

管理可信节点的 DN（Distinguished Name）列表，用于节点间 TLS 通信认证。

GET _security/nodesdn/
GET _security/nodesdn/{name}
DELETE _security/nodesdn/{name}
PUT _security/nodesdn/{name}
PATCH _security/nodesdn/
PATCH _security/nodesdn/{name}

URL 参数 #

HTTP 请求体（PUT/PATCH） #

节点 DN 配置内容。

security.permissionsinfo #

获取当前用户的权限信息。

GET _security/permissionsinfo

security.privilege #

管理操作组（权限组），用于将多个权限打包为一个命名集合。

GET _security/privilege/
GET _security/privilege/{name}
DELETE _security/privilege/{name}
PUT _security/privilege/{name}
PATCH _security/privilege/
PATCH _security/privilege/{name}

URL 参数 #

HTTP 请求体（PUT/PATCH） #

操作组定义，包含允许的操作列表。

security.role #

管理安全角色。角色定义了用户可以访问的集群权限和索引权限。

GET _security/role/
GET _security/role/{name}
DELETE _security/role/{name}
PUT _security/role/{name}
PATCH _security/role/
PATCH _security/role/{name}

URL 参数 #

HTTP 请求体（PUT/PATCH） #

角色定义，包含集群权限、索引权限、租户权限等。

security.role_mapping #

管理角色映射，将后端角色、用户等映射到安全角色。

GET _security/role_mapping/
GET _security/role_mapping/{name}
DELETE _security/role_mapping/{name}
PUT _security/role_mapping/{name}
PATCH _security/role_mapping/
PATCH _security/role_mapping/{name}

URL 参数 #

HTTP 请求体（PUT/PATCH） #

角色映射定义，包含后端角色、用户、主机列表等。

security.ssl_certificates #

获取 SSL/TLS 证书信息。

GET _security/ssl/certificates

security.ssl_certs #

获取节点的 SSL/TLS 证书详细信息。

GET _security/ssl/certs

security.ssl_reload_certs #

重新加载指定类型的 SSL/TLS 证书，无需重启节点。

PUT _security/ssl/{certType}/reloadcerts/

URL 参数 #

security.sslinfo #

获取节点的 SSL/TLS 配置信息。

GET _security/sslinfo

security.user #

管理内部用户。支持创建、读取、更新和删除用户。

GET _security/user/
GET _security/user/{name}
DELETE _security/user/{name}
PUT _security/user/{name}
PATCH _security/user/
PATCH _security/user/{name}

URL 参数 #

HTTP 请求体（PUT/PATCH） #

用户定义，包含密码、后端角色、属性等。

security.validate #

验证安全模块配置的有效性。

GET _security/validate

security.whitelist #

管理 API 白名单。控制哪些 REST API 端点可以被访问。

GET _security/whitelist
PUT _security/whitelist
PATCH _security/whitelist

HTTP 请求体（PUT/PATCH） #

白名单配置，包含允许的 API 端点列表。

snapshot.cleanup_repository #

清理快照仓库中未被引用的过期数据。

POST _snapshot/{repository}/_cleanup

URL 参数 #

snapshot.clone #

在同一仓库内将快照中的索引克隆到另一个快照。

PUT _snapshot/{repository}/{snapshot}/_clone/{target_snapshot}

HTTP 请求体 #

快照克隆定义

必需：是

URL 参数 #

snapshot.create #

在仓库中创建快照。

PUT _snapshot/{repository}/{snapshot}
POST _snapshot/{repository}/{snapshot}

HTTP 请求体 #

快照定义

必需：否

URL 参数 #

snapshot.create_repository #

创建快照仓库。

PUT _snapshot/{repository}
POST _snapshot/{repository}

HTTP 请求体 #

仓库定义

必需：是

URL 参数 #

snapshot.delete #

删除快照。

DELETE _snapshot/{repository}/{snapshot}

URL 参数 #

snapshot.delete_repository #

删除快照仓库。

DELETE _snapshot/{repository}

URL 参数 #

snapshot.get #

返回快照的信息。

GET _snapshot/{repository}/{snapshot}

URL 参数 #

snapshot.get_repository #

返回快照仓库的信息。

GET _snapshot

GET _snapshot/{repository}

URL 参数 #

snapshot.restore #

从快照恢复数据。

POST _snapshot/{repository}/{snapshot}/_restore

HTTP 请求体 #

要恢复的详细信息

必需：否

URL 参数 #

snapshot.status #

返回快照的详细状态信息。

GET _snapshot/_status

GET _snapshot/{repository}/_status

GET _snapshot/{repository}/{snapshot}/_status

URL 参数 #

snapshot.verify_repository #

验证快照仓库的可用性。

POST _snapshot/{repository}/_verify

URL 参数 #

sql.close_cursor #

关闭 SQL 查询的游标，释放服务端资源。

POST _sql/close

HTTP 请求体 #

包含要关闭的游标 ID。

sql.explain #

对 SQL 查询语句进行解析，返回对应的 Easysearch 查询 DSL，而不实际执行查询。

POST _sql/_explain

HTTP 请求体 #

SQL 查询语句。

sql.query #

执行 SQL 查询并返回结果。支持 JDBC 格式输出。

POST _sql

URL 参数 #

HTTP 请求体 #

SQL 查询语句及参数。

sql.settings #

更新 SQL 插件的查询设置。

PUT _sql/_query/settings

HTTP 请求体 #

sql.stats #

获取 SQL 插件的统计指标。

POST _sql/stats

tasks.cancel #

取消正在执行的任务（如果该任务支持通过 API 取消）。

POST _tasks/_cancel

POST _tasks/{task_id}/_cancel

URL 参数 #

tasks.get #

返回指定任务的详细信息。

GET _tasks/{task_id}

URL 参数 #

tasks.list #

返回正在执行的任务列表。

GET _tasks

URL 参数 #

termvectors #

返回指定文档字段中词项的信息和统计数据。

GET {index}/_termvectors/{id}
POST {index}/_termvectors/{id}

GET {index}/_termvectors
POST {index}/_termvectors

GET {index}/{type}/{id}/_termvectors
POST {index}/{type}/{id}/_termvectors

GET {index}/{type}/_termvectors
POST {index}/{type}/_termvectors

HTTP 请求体 #

定义参数和/或提供文档以获取词条向量。详见文档。

必需：否

URL 参数 #

update #

使用脚本或部分文档更新文档。

POST {index}/_update/{id}

POST {index}/{type}/{id}/_update

HTTP 请求体 #

请求定义需要 script 或部分 doc

必需：是

URL 参数 #

update_by_query #

对索引中的每个文档执行更新而不更改源数据， 例如以应用映射变更。

POST {index}/_update_by_query

POST {index}/{type}/_update_by_query

HTTP 请求体 #

使用 Query DSL 的搜索定义

URL 参数 #

update_by_query_rethrottle #

修改 update-by-query 操作的每秒请求数。

POST _update_by_query/{task_id}/_rethrottle

URL 参数 #