API 参考

批量索引或删除文档。在单个 API 调用中执行多个索引或删除操作。这减少了开销，并可以大大提高索引速度。

端点文档

client.bulk({ ... })

清除滚动搜索。

清除滚动搜索的搜索上下文和结果。

端点文档

client.clearScroll({ ... })

关闭时间点。

必须先显式打开时间点，才能在搜索请求中使用。 keep_alive 参数告诉 Elasticsearch 它应该持久化多长时间。当 keep_alive 期限已过时，时间点会自动关闭。但是，保留时间点是有成本的；一旦不再需要用于搜索请求，请立即关闭它们。

端点文档

client.closePointInTime({ id })

计算搜索结果。获取与查询匹配的文档数。

端点文档

client.count({ ... })

索引文档。将 JSON 文档添加到指定的数据流或索引，并使其可搜索。如果目标是索引并且该文档已存在，则请求会更新该文档并增加其版本。

端点文档

client.create({ id, index })

删除文档。从指定的索引中删除 JSON 文档。

端点文档

client.delete({ id, index })

删除文档。删除与指定查询匹配的文档。

端点文档

client.deleteByQuery({ index })

限制按查询删除操作。

更改特定按查询删除操作的每秒请求数。加快查询速度的重新限制会立即生效，但减慢查询速度的重新限制会在完成当前批处理后生效，以防止滚动超时。

端点文档

client.deleteByQueryRethrottle({ task_id })

删除脚本或搜索模板。删除存储的脚本或搜索模板。

端点文档

client.deleteScript({ id })

检查文档。检查指定的文档是否存在。

端点文档

client.exists({ id, index })

检查文档源。检查是否存储了文档的 _source。

端点文档

client.existsSource({ id, index })

解释文档匹配结果。返回有关为什么特定文档匹配或不匹配查询的信息。

端点文档

client.explain({ id, index })

获取字段功能。

获取多个索引中字段功能的信息。

对于数据流，API 会返回流后备索引中的字段功能。它像任何其他字段一样返回运行时字段。例如，类型为 keyword 的运行时字段与属于 keyword 系列的任何其他字段返回的方式相同。

端点文档

client.fieldCaps({ ... })

根据文档 ID 获取文档。从索引中检索具有指定 ID 的文档。

端点文档

client.get({ id, index })

获取脚本或搜索模板。检索存储的脚本或搜索模板。

端点文档

client.getScript({ id })

获取脚本上下文。

获取支持的脚本上下文及其方法列表。

端点文档

client.getScriptContext()

获取脚本语言。

获取可用脚本类型、语言和上下文的列表。

端点文档

client.getScriptLanguages()

获取文档的源。返回文档的源。

端点文档

client.getSource({ id, index })

返回集群的运行状况。

端点文档

client.healthReport({ ... })

索引文档。将 JSON 文档添加到指定的数据流或索引，并使其可搜索。如果目标是索引并且该文档已存在，则请求会更新该文档并增加其版本。

端点文档

client.index({ index })

获取集群信息。返回有关集群的基本信息。

端点文档

client.info()

运行 kNN 搜索。

对 dense_vector 字段执行 k 近邻 (kNN) 搜索，并返回匹配的文档。给定一个查询向量，API 会查找 k 个最接近的向量，并将这些文档作为搜索命中返回。

Elasticsearch 使用 HNSW 算法来支持高效的 kNN 搜索。与大多数 kNN 算法一样，HNSW 是一种近似方法，它牺牲结果精度来提高搜索速度。这意味着返回的结果不总是真正的 k 个最接近的邻居。

kNN 搜索 API 支持使用过滤器限制搜索。搜索将返回也匹配过滤器查询的前 k 个文档。

端点文档

client.knnSearch({ index, knn })

获取多个文档。

从一个或多个索引中按 ID 获取多个 JSON 文档。如果在请求 URI 中指定了索引，则只需在请求正文中指定文档 ID。为确保快速响应，如果一个或多个分片失败，此多重获取 (mget) API 将响应部分结果。

端点文档

client.mget({ ... })

运行多个搜索。

请求的格式类似于批量 API 格式，并使用换行符分隔的 JSON (NDJSON) 格式。结构如下

header\n
body\n
header\n
body\n

此结构经过专门优化，如果特定的搜索最终被重定向到另一个节点，则可以减少解析。

端点文档

client.msearch({ ... })

运行多个模板搜索。

端点文档

client.msearchTemplate({ ... })

获取多个词项向量。

您可以通过索引和 ID 指定现有文档，或者在请求正文中提供人工文档。您可以在请求正文或请求 URI 中指定索引。响应包含一个 docs 数组，其中包含所有获取的词项向量。每个元素的结构由词项向量 API 提供。

端点文档

client.mtermvectors({ ... })

打开时间点。

搜索请求默认针对目标索引的最新可见数据运行，这称为时间点。Elasticsearch pit（时间点）是对启动时存在的数据状态的轻量级视图。在某些情况下，最好使用相同的时间点执行多个搜索请求。例如，如果在 search_after 请求之间发生刷新，则这些请求的结果可能不一致，因为搜索之间发生的变化仅对最近的时间点可见。

时间点必须先显式打开，然后才能在搜索请求中使用。keep_alive 参数告诉 Elasticsearch 它应该保留多长时间。

端点文档

client.openPointInTime({ index, keep_alive })

Ping 集群。返回集群是否正在运行。

端点文档

client.ping()

创建或更新脚本或搜索模板。创建或更新存储的脚本或搜索模板。

端点文档

client.putScript({ id, script })

评估排名搜索结果。

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

端点文档

client.rankEval({ requests })

重新索引文档。将文档从源复制到目标。源可以是任何现有索引、别名或数据流。目标必须与源不同。例如，您不能将数据流重新索引到自身。

端点文档

client.reindex({ dest, source })

限制重新索引操作。

更改特定重新索引操作的每秒请求数。

端点文档

client.reindexRethrottle({ task_id })

渲染搜索模板。

将搜索模板渲染为搜索请求主体。

端点文档

client.renderSearchTemplate({ ... })

运行脚本。运行脚本并返回结果。

端点文档

client.scriptsPainlessExecute({ ... })

运行滚动搜索。

scroll API 从单个滚动搜索请求中获取大量结果集。要获取必要的 scroll ID，请提交包含 scroll 查询参数参数的搜索 API 请求。scroll 参数指示 Elasticsearch 应为该请求保留搜索上下文的时间。搜索响应会在 _scroll_id 响应主体参数中返回一个 scroll ID。然后，您可以将 scroll ID 与 scroll API 一起使用，以检索该请求的下一批结果。如果启用了 Elasticsearch 安全功能，则对特定 scroll ID 结果的访问权限将限制为提交搜索的用户或 API 密钥。

您还可以使用 scroll API 指定一个新的 scroll 参数，该参数延长或缩短搜索上下文的保留时间。

端点文档

client.scroll({ scroll_id })

运行搜索。

获取与请求中定义的查询匹配的搜索匹配项。您可以使用 q 查询字符串参数或请求主体提供搜索查询。如果同时指定了两者，则仅使用查询参数。

端点文档

client.search({ ... })

搜索矢量切片。

搜索矢量切片以获取地理空间值。

端点文档

client.searchMvt({ index, field, zoom, x, y })

支持以下聚合类型：- avg - cardinality - max - min - sum buffer (可选，数字)：切片外部的裁剪缓冲区的大小（以像素为单位）。这允许渲染器避免几何图形超出切片范围时产生的轮廓伪影。 exact_bounds (可选，布尔值)：如果为 false，则元图层的要素是切片的边界框。如果为 true，则元图层的要素是从 geo_bounds 聚合产生的边界框。聚合在与 <zoom>/<x>/<y> 切片相交且 wrap_longitude 设置为 false 的 <field> 值上运行。生成的边界框可能大于矢量切片。 extent (可选，数字)：切片一侧的大小（以像素为单位）。矢量切片是边长相等的正方形。 fields (可选，字符串 | 字符串数组)：要在 hits 图层中返回的字段。支持通配符 (*)。此参数不支持具有数组值的字段。具有数组值的字段可能会返回不一致的结果。 grid_agg (可选，枚举值("geotile" | "geohex"))：用于为 field 创建网格的聚合。 grid_precision (可选，数字)：可通过 aggs 图层使用的其他缩放级别。例如，如果 <zoom> 为 7 且 grid_precision 为 8，则最多可以放大到级别 15。接受 0-8。如果为 0，则结果不包含 aggs 图层。 grid_type (可选，枚举值("grid" | "point" | "centroid"))：确定 aggs 图层中要素的几何类型。在 aggs 图层中，每个要素都表示一个 geotile_grid 单元格。如果为 *grid*，则每个要素都是单元格边界框的 Polygon。如果为 *point*，则每个要素都是单元格质心的 Point。 query (可选，{ bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })：用于筛选搜索文档的查询 DSL。 runtime_mappings (可选，Record<字符串, { fields, fetch_fields, format, input_field, target_field, target_index, script, type }>)：在搜索请求中定义一个或多个运行时字段。这些字段优先于具有相同名称的映射字段。 size (可选，数字)：hits 图层中要返回的最大要素数量。接受 0-10000。如果为 0，则结果不包含 hits 图层。 sort (可选，字符串 | { _score, _doc, _geo_distance, _script } | 字符串 | { _score, _doc, _geo_distance, _script }[])：对 hits 图层中的要素进行排序。默认情况下，API 计算每个要素的边界框。它根据此框的对角线长度对要素进行排序，从最长到最短。 track_total_hits (可选，布尔值 | 数字)：准确计算与查询匹配的命中次数。如果为 true，则会返回确切的命中次数，但会牺牲一些性能。如果为 false，则响应不包含与查询匹配的命中总数。* *with_labels (可选，布尔值)：如果为 true，则 hits 和 aggs 图层将包含额外的点要素，这些要素表示原始要素的建议标签位置。

获取搜索分片。

获取将针对其运行搜索请求的索引和分片。此信息对于解决问题或规划路由和分片首选项的优化非常有用。使用筛选的别名时，筛选器将作为索引部分的一部分返回。

端点文档

client.searchShards({ ... })

使用搜索模板运行搜索。

端点文档

client.searchTemplate({ ... })

获取索引中的词条。

在索引中发现与部分字符串匹配的词条。此“词条枚举”API 专为自动完成场景中使用的低延迟查找而设计。

如果响应中的 complete 属性为 false，则返回的词条集可能不完整，应视为近似值。这可能是由一些原因导致的，例如请求超时或节点错误。

端点文档

client.termsEnum({ index, field })

获取词条向量信息。

获取有关特定文档字段中词条的信息和统计数据。

端点文档

client.termvectors({ index })

更新文档。通过运行脚本或传递部分文档来更新文档。

端点文档

client.update({ id, index })

更新文档。更新与指定查询匹配的文档。如果未指定查询，则对数据流或索引中的每个文档执行更新，而不修改源，这对于拾取映射更改非常有用。

端点文档

client.updateByQuery({ index })

限制按查询更新操作。

通过查询操作更改特定更新的每秒请求数。加快查询速度的重新限流会立即生效，但减慢查询速度的重新限流会在完成当前批次后生效，以防止滚动超时。

端点文档

client.updateByQueryRethrottle({ task_id })

删除异步搜索。

如果异步搜索仍在运行，则会取消。否则，将删除已保存的搜索结果。如果启用了 Elasticsearch 安全功能，则特定异步搜索的删除仅限于：提交原始搜索请求的已验证用户；具有 cancel_task 集群权限的用户。

端点文档

client.asyncSearch.delete({ id })

获取异步搜索结果。

检索先前提交的异步搜索请求的结果。如果启用了 Elasticsearch 安全功能，则对特定异步搜索结果的访问仅限于提交该请求的用户或 API 密钥。

端点文档

client.asyncSearch.get({ id })

获取异步搜索状态。

获取先前提交的异步搜索请求的状态（给定其标识符），而无需检索搜索结果。如果启用了 Elasticsearch 安全功能，则此 API 的使用仅限于 monitoring_user 角色。

端点文档

client.asyncSearch.status({ id })

运行异步搜索。

当结果的主要排序是索引字段时，分片将根据它们保存的该字段的最小值和最大值进行排序。根据所请求的排序标准，部分结果可用。

警告：异步搜索不支持滚动或仅包含建议部分的搜索请求。

默认情况下，Elasticsearch 不允许存储大于 10Mb 的异步搜索响应，尝试执行此操作会导致错误。可以通过更改 search.max_async_search_response_size 集群级设置来设置存储的异步搜索响应的最大允许大小。

端点文档

client.asyncSearch.submit({ ... })

删除自动缩放策略。

端点文档

client.autoscaling.deleteAutoscalingPolicy({ name })

获取自动缩放容量。

此 API 根据配置的自动缩放策略获取当前自动缩放容量。它将返回信息，以便根据当前工作负载调整集群的大小。

required_capacity 计算为策略启用的所有单个决策者的 required_capacity 结果的最大值。

操作员应验证 current_nodes 是否与操作员所知的集群匹配，以避免基于过时或不完整的信息做出自动缩放决策。

响应包含特定于决策者的信息，您可以使用这些信息来诊断自动缩放如何以及为什么确定需要特定容量。此信息仅供诊断使用。请勿使用此信息来做出自动缩放决策。

端点文档

client.autoscaling.getAutoscalingCapacity({ ... })

获取自动缩放策略。

端点文档

client.autoscaling.getAutoscalingPolicy({ name })

创建或更新自动缩放策略。

端点文档

client.autoscaling.putAutoscalingPolicy({ name })

获取别名。检索集群的索引别名，包括筛选器和路由信息。该 API 不返回数据流别名。

CAT API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适合应用程序使用。对于应用程序使用，请使用别名 API。

端点文档

client.cat.aliases({ ... })

提供分配给每个数据节点的分片数及其磁盘空间的快照。重要提示：cat API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适合应用程序使用。

端点文档

client.cat.allocation({ ... })

获取组件模板。返回有关集群中组件模板的信息。组件模板是构建索引模板的构建块，这些模板指定索引映射、设置和别名。

CAT API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适合应用程序使用。对于应用程序使用，请使用获取组件模板 API。

端点文档

client.cat.componentTemplates({ ... })

获取文档计数。提供对数据流、索引或整个集群的文档计数的快速访问。文档计数仅包括实时文档，不包括尚未被合并过程删除的已删除文档。

CAT API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适合应用程序使用。对于应用程序使用，请使用计数 API。

端点文档

client.cat.count({ ... })

返回集群中每个数据节点上当前由字段数据缓存使用的堆内存量。重要提示：cat API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适合应用程序使用。对于应用程序使用，请使用节点统计信息 API。

端点文档

client.cat.fielddata({ ... })

返回集群的健康状态，类似于集群健康状态 API。重要提示：cat API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适合应用程序使用。对于应用程序使用，请使用集群健康状态 API。此 API 通常用于检查发生故障的集群。为了帮助您跟踪集群健康状态以及日志文件和警报系统，API 以两种格式返回时间戳：HH:MM:SS，这是人类可读的，但不包含日期信息；Unix epoch time，这是机器可排序的，并且包含日期信息。后一种格式对于需要多天才能完成的集群恢复非常有用。您可以使用 cat 健康状态 API 来验证多个节点上的集群健康状态。您还可以使用 API 跟踪大型集群在较长时间内的恢复情况。

端点文档

client.cat.health({ ... })

获取 CAT 帮助。返回 CAT API 的帮助信息。

端点文档

client.cat.help()

获取索引信息。返回有关集群中索引的高级信息，包括数据流的后备索引。

使用此请求获取集群中每个索引的以下信息： - 分片计数 - 文档计数 - 已删除文档计数 - 主要存储大小 - 所有分片（包括分片副本）的总存储大小

这些指标直接从 Lucene 中检索，Elasticsearch 在内部使用 Lucene 来支持索引和搜索。因此，所有文档计数都包含隐藏的嵌套文档。要获得 Elasticsearch 文档的准确计数，请使用 cat 计数或计数 API。

CAT API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适合应用程序使用。对于应用程序使用，请使用索引端点。

端点文档

client.cat.indices({ ... })

返回有关主节点的信息，包括 ID、绑定的 IP 地址和名称。重要提示：cat API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适合应用程序使用。对于应用程序使用，请使用节点信息 API。

端点文档

client.cat.master()

获取数据帧分析作业。返回有关数据帧分析作业的配置和使用信息。

CAT API 仅供使用 Kibana 控制台或命令行的人员使用。它们不适合应用程序使用。对于应用程序使用，请使用获取数据帧分析作业统计信息 API。

端点文档

client.cat.mlDataFrameAnalytics({ ... })

获取数据馈送。返回有关数据馈送的配置和使用信息。此 API 最多返回 10,000 个数据馈送。如果启用了 Elasticsearch 安全功能，您必须拥有 monitor_ml、monitor、manage_ml 或 manage 集群权限才能使用此 API。

CAT API 仅供人在 Kibana 控制台或命令行中使用。它们不适用于应用程序。对于应用程序使用，请使用获取数据馈送统计信息 API。

端点文档

client.cat.mlDatafeeds({ ... })

如果为 true，则当没有匹配项时，API 返回一个空数据馈送数组；当有部分匹配项时，返回结果的子集。如果为 false，则当没有匹配项或只有部分匹配项时，API 返回 404 状态代码。h (可选, 枚举("ae" | "bc" | "id" | "na" | "ne" | "ni" | "nn" | "sba" | "sc" | "seah" | "st" | "s") | 枚举("ae" | "bc" | "id" | "na" | "ne" | "ni" | "nn" | "sba" | "sc" | "seah" | "st" | "s")[])：要显示的列名称列表。 s (可选, 枚举("ae" | "bc" | "id" | "na" | "ne" | "ni" | "nn" | "sba" | "sc" | "seah" | "st" | "s") | 枚举("ae" | "bc" | "id" | "na" | "ne" | "ni" | "nn" | "sba" | "sc" | "seah" | "st" | "s")[])：用于对响应进行排序的列名称或列别名列表。 * *time (可选, 枚举("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))：用于显示时间值的单位。

获取异常检测作业。返回异常检测作业的配置和使用信息。此 API 最多返回 10,000 个作业。如果启用了 Elasticsearch 安全功能，您必须拥有 monitor_ml、monitor、manage_ml 或 manage 集群权限才能使用此 API。

CAT API 仅供人在 Kibana 控制台或命令行中使用。它们不适用于应用程序。对于应用程序使用，请使用获取异常检测作业统计信息 API。

端点文档

client.cat.mlJobs({ ... })

如果为 true，则当没有匹配项时，API 返回一个空作业数组；当有部分匹配项时，返回结果的子集。如果为 false，则当没有匹配项或只有部分匹配项时，API 返回 404 状态代码。bytes (可选, 枚举("b" | "kb" | "mb" | "gb" | "tb" | "pb"))：用于显示字节值的单位。 h (可选, 枚举("assignment_explanation" | "buckets.count" | "buckets.time.exp_avg" | "buckets.time.exp_avg_hour" | "buckets.time.max" | "buckets.time.min" | "buckets.time.total" | "data.buckets" | "data.earliest_record" | "data.empty_buckets" | "data.input_bytes" | "data.input_fields" | "data.input_records" | "data.invalid_dates" | "data.last" | "data.last_empty_bucket" | "data.last_sparse_bucket" | "data.latest_record" | "data.missing_fields" | "data.out_of_order_timestamps" | "data.processed_fields" | "data.processed_records" | "data.sparse_buckets" | "forecasts.memory.avg" | "forecasts.memory.max" | "forecasts.memory.min" | "forecasts.memory.total" | "forecasts.records.avg" | "forecasts.records.max" | "forecasts.records.min" | "forecasts.records.total" | "forecasts.time.avg" | "forecasts.time.max" | "forecasts.time.min" | "forecasts.time.total" | "forecasts.total" | "id" | "model.bucket_allocation_failures" | "model.by_fields" | "model.bytes" | "model.bytes_exceeded" | "model.categorization_status" | "model.categorized_doc_count" | "model.dead_category_count" | "model.failed_category_count" | "model.frequent_category_count" | "model.log_time" | "model.memory_limit" | "model.memory_status" | "model.over_fields" | "model.partition_fields" | "model.rare_category_count" | "model.timestamp" | "model.total_category_count" | "node.address" | "node.ephemeral_id" | "node.id" | "node.name" | "opened_time" | "state") | 枚举("assignment_explanation" | "buckets.count" | "buckets.time.exp_avg" | "buckets.time.exp_avg_hour" | "buckets.time.max" | "buckets.time.min" | "buckets.time.total" | "data.buckets" | "data.earliest_record" | "data.empty_buckets" | "data.input_bytes" | "data.input_fields" | "data.input_records" | "data.invalid_dates" | "data.last" | "data.last_empty_bucket" | "data.last_sparse_bucket" | "data.latest_record" | "data.missing_fields" | "data.out_of_order_timestamps" | "data.processed_fields" | "data.processed_records" | "data.sparse_buckets" | "forecasts.memory.avg" | "forecasts.memory.max" | "forecasts.memory.min" | "forecasts.memory.total" | "forecasts.records.avg" | "forecasts.records.max" | "forecasts.records.min" | "forecasts.records.total" | "forecasts.time.avg" | "forecasts.time.max" | "forecasts.time.min" | "forecasts.time.total" | "forecasts.total" | "id" | "model.bucket_allocation_failures" | "model.by_fields" | "model.bytes" | "model.bytes_exceeded" | "model.categorization_status" | "model.categorized_doc_count" | "model.dead_category_count" | "model.failed_category_count" | "model.frequent_category_count" | "model.log_time" | "model.memory_limit" | "model.memory_status" | "model.over_fields" | "model.partition_fields" | "model.rare_category_count" | "model.timestamp" | "model.total_category_count" | "node.address" | "node.ephemeral_id" | "node.id" | "node.name" | "opened_time" | "state")[])：要显示的列名称列表。 s (可选, 枚举("assignment_explanation" | "buckets.count" | "buckets.time.exp_avg" | "buckets.time.exp_avg_hour" | "buckets.time.max" | "buckets.time.min" | "buckets.time.total" | "data.buckets" | "data.earliest_record" | "data.empty_buckets" | "data.input_bytes" | "data.input_fields" | "data.input_records" | "data.invalid_dates" | "data.last" | "data.last_empty_bucket" | "data.last_sparse_bucket" | "data.latest_record" | "data.missing_fields" | "data.out_of_order_timestamps" | "data.processed_fields" | "data.processed_records" | "data.sparse_buckets" | "forecasts.memory.avg" | "forecasts.memory.max" | "forecasts.memory.min" | "forecasts.memory.total" | "forecasts.records.avg" | "forecasts.records.max" | "forecasts.records.min" | "forecasts.records.total" | "forecasts.time.avg" | "forecasts.time.max" | "forecasts.time.min" | "forecasts.time.total" | "forecasts.total" | "id" | "model.bucket_allocation_failures" | "model.by_fields" | "model.bytes" | "model.bytes_exceeded" | "model.categorization_status" | "model.categorized_doc_count" | "model.dead_category_count" | "model.failed_category_count" | "model.frequent_category_count" | "model.log_time" | "model.memory_limit" | "model.memory_status" | "model.over_fields" | "model.partition_fields" | "model.rare_category_count" | "model.timestamp" | "model.total_category_count" | "node.address" | "node.ephemeral_id" | "node.id" | "node.name" | "opened_time" | "state") | 枚举("assignment_explanation" | "buckets.count" | "buckets.time.exp_avg" | "buckets.time.exp_avg_hour" | "buckets.time.max" | "buckets.time.min" | "buckets.time.total" | "data.buckets" | "data.earliest_record" | "data.empty_buckets" | "data.input_bytes" | "data.input_fields" | "data.input_records" | "data.invalid_dates" | "data.last" | "data.last_empty_bucket" | "data.last_sparse_bucket" | "data.latest_record" | "data.missing_fields" | "data.out_of_order_timestamps" | "data.processed_fields" | "data.processed_records" | "data.sparse_buckets" | "forecasts.memory.avg" | "forecasts.memory.max" | "forecasts.memory.min" | "forecasts.memory.total" | "forecasts.records.avg" | "forecasts.records.max" | "forecasts.records.min" | "forecasts.records.total" | "forecasts.time.avg" | "forecasts.time.max" | "forecasts.time.min" | "forecasts.time.total" | "forecasts.total" | "id" | "model.bucket_allocation_failures" | "model.by_fields" | "model.bytes" | "model.bytes_exceeded" | "model.categorization_status" | "model.categorized_doc_count" | "model.dead_category_count" | "model.failed_category_count" | "model.frequent_category_count" | "model.log_time" | "model.memory_limit" | "model.memory_status" | "model.over_fields" | "model.partition_fields" | "model.rare_category_count" | "model.timestamp" | "model.total_category_count" | "node.address" | "node.ephemeral_id" | "node.id" | "node.name" | "opened_time" | "state")[])：用于对响应进行排序的列名称或列别名列表。 time (可选, 枚举("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))：用于显示时间值的单位。

获取已训练的模型。返回有关推理已训练模型的配置和使用信息。

CAT API 仅供人在 Kibana 控制台或命令行中使用。它们不适用于应用程序。对于应用程序使用，请使用获取已训练模型统计信息 API。

端点文档

client.cat.mlTrainedModels({ ... })

返回有关自定义节点属性的信息。重要提示：cat API 仅供人在命令行或 Kibana 控制台中使用。它们不适用于应用程序。对于应用程序使用，请使用节点信息 API。

端点文档

client.cat.nodeattrs()

返回集群中节点的相关信息。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用节点信息 API。

端点文档

client.cat.nodes({ ... })

返回尚未执行的集群级更改。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用待处理的集群任务 API。

端点文档

client.cat.pendingTasks()

返回集群中每个节点上运行的插件列表。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用节点信息 API。

端点文档

client.cat.plugins()

返回有关正在进行和已完成的分片恢复的信息。分片恢复是指初始化分片副本的过程，例如从快照还原主分片或从主分片同步副本分片。当分片恢复完成时，恢复的分片可用于搜索和索引。对于数据流，API 返回有关流的支持索引的信息。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用索引恢复 API。

端点文档

client.cat.recovery({ ... })

返回集群的快照存储库。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用获取快照存储库 API。

端点文档

client.cat.repositories()

返回有关索引分片中 Lucene 段的底层信息。对于数据流，API 返回有关支持索引的信息。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用索引段 API。

端点文档

client.cat.segments({ ... })

返回有关集群中分片的信息。对于数据流，API 返回有关支持索引的信息。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。

端点文档

client.cat.shards({ ... })

返回有关存储在一个或多个存储库中的快照的信息。快照是索引或正在运行的 Elasticsearch 集群的备份。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用获取快照 API。

端点文档

client.cat.snapshots({ ... })

返回有关当前在集群中执行的任务的信息。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用任务管理 API。

端点文档

client.cat.tasks({ ... })

返回有关集群中索引模板的信息。可以使用索引模板在创建时将索引设置和字段映射应用于新索引。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用获取索引模板 API。

端点文档

client.cat.templates({ ... })

返回集群中每个节点的线程池统计信息。返回的信息包括所有内置线程池和自定义线程池。重要提示：cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用节点信息 API。

端点文档

client.cat.threadPool({ ... })

获取转换。返回有关转换的配置和使用信息。

CAT API 仅供人类通过 Kibana 控制台或命令行使用。它们不适用于应用程序使用。对于应用程序使用，请使用获取转换统计信息 API。

端点文档

client.cat.transforms({ ... })

删除自动关注模式。

端点文档

client.ccr.deleteAutoFollowPattern({ name })

创建一个新的跟随者索引，配置为跟随引用的领导者索引。

端点文档

client.ccr.follow({ index })

检索有关所有跟随者索引的信息，包括每个跟随者索引的参数和状态

端点文档

client.ccr.followInfo({ index })

检索跟随者统计信息。返回有关指定索引的每个分片关联的以下任务的分片级统计信息。

端点文档

client.ccr.followStats({ index })

从领导者中删除跟随者保留租约。

端点文档

client.ccr.forgetFollower({ index })

获取配置的自动跟随模式。返回指定的自动跟随模式集合。

端点文档

client.ccr.getAutoFollowPattern({ ... })

暂停自动跟随模式

端点文档

client.ccr.pauseAutoFollowPattern({ name })

暂停跟随者索引。跟随者索引将不会从领导者索引获取任何其他操作。

端点文档

client.ccr.pauseFollow({ index })

针对指定的远程集群创建新的自动跟随模式命名集合。远程集群上新创建的与任何指定模式匹配的索引将自动配置为跟随者索引。

端点文档

client.ccr.putAutoFollowPattern({ name, remote_cluster })

恢复已暂停的自动跟随模式

端点文档

client.ccr.resumeAutoFollowPattern({ name })

恢复已暂停的跟随者索引

端点文档

client.ccr.resumeFollow({ index })

获取与跨集群复制相关的所有统计信息。

端点文档

client.ccr.stats()

停止与跟随者索引关联的跟随任务，并删除与跨集群复制关联的索引元数据和设置。

端点文档

client.ccr.unfollow({ index })

提供集群中分片分配的说明。

端点文档

client.cluster.allocationExplain({ ... })

删除组件模板。删除组件模板。组件模板是构建索引模板的构建块，用于指定索引映射、设置和别名。

端点文档

client.cluster.deleteComponentTemplate({ name })

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

端点文档

client.cluster.deleteVotingConfigExclusions({ ... })

检查组件模板。返回有关特定组件模板是否存在的信息。

端点文档

client.cluster.existsComponentTemplate({ name })

获取组件模板。检索有关组件模板的信息。

端点文档

client.cluster.getComponentTemplate({ ... })

返回集群范围的设置。默认情况下，它仅返回已明确定义的设置。

端点文档

client.cluster.getSettings({ ... })

集群运行状况 API 返回有关集群运行状况的简单状态。您还可以使用此 API 仅获取指定数据流和索引的运行状况状态。对于数据流，此 API 检索流的后备索引的运行状况状态。集群运行状况状态为：绿色、黄色或红色。在分片级别，红色状态表示特定分片未在集群中分配，黄色表示已分配主分片但未分配副本，绿色表示已分配所有分片。索引级别状态由最差分片状态控制。集群状态由最差索引状态控制。

端点文档

client.cluster.health({ ... })

获取集群信息。返回有关集群的基本信息。

端点文档

client.cluster.info({ target })

返回尚未执行的集群级更改（例如创建索引、更新映射、分配或失败分片）。注意：此 API 返回集群状态的任何待处理更新的列表。这些与任务管理 API 报告的任务不同，后者包括周期性任务和用户发起的任务，例如节点统计、搜索查询或创建索引请求。但是，如果用户发起的任务（例如创建索引命令）导致集群状态更新，则此任务的活动可能会由任务 API 和待处理集群任务 API 报告。

端点文档

client.cluster.pendingTasks({ ... })

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

端点文档

client.cluster.postVotingConfigExclusions({ ... })

创建或更新组件模板。创建或更新组件模板。组件模板是用于构建索引模板的构建块，用于指定索引映射、设置和别名。

一个索引模板可以由多个组件模板组成。要使用组件模板，请在索引模板的 composed_of 列表中指定它。组件模板仅作为匹配索引模板的一部分应用于新的数据流和索引。

直接在索引模板或创建索引请求中指定的设置和映射将覆盖组件模板中指定的任何设置或映射。

组件模板仅在索引创建期间使用。对于数据流，这包括数据流的创建和流的后备索引的创建。对组件模板的更改不会影响现有索引，包括流的后备索引。

您可以在组件模板中使用 C 样式 /* */ 块注释。您可以在请求正文中的任何位置包含注释，除了在开头的花括号之前。

端点文档

client.cluster.putComponentTemplate({ name, template })

更新集群设置。

端点文档

client.cluster.putSettings({ ... })

集群远程信息 API 允许您检索所有配置的远程集群信息。它返回按配置的远程集群别名键控的连接和端点信息。

端点文档

client.cluster.remoteInfo()

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

端点文档

client.cluster.reroute({ ... })

返回有关集群状态的全面信息。

端点文档

client.cluster.state({ ... })

返回集群统计信息。它返回基本索引指标（分片数量、存储大小、内存使用情况）和有关构成集群的当前节点的信息（数量、角色、操作系统、JVM 版本、内存使用情况、CPU 和安装的插件）。

端点文档

client.cluster.stats({ ... })

签入连接器。

更新连接器中的 last_seen 字段，并将其设置为当前时间戳。

端点文档

client.connector.checkIn({ connector_id })

删除连接器。

删除连接器和关联的同步作业。这是一个不可恢复的破坏性操作。注意：此操作不会删除与连接器关联的任何 API 密钥、摄取管道或数据索引。这些需要手动删除。

端点文档

client.connector.delete({ connector_id })

获取连接器。

获取有关连接器的详细信息。

端点文档

client.connector.get({ connector_id })

获取所有连接器。

获取有关所有连接器的信息。

端点文档

client.connector.list({ ... })

创建连接器。

连接器是 Elasticsearch 集成，可从第三方数据源引入内容，这些内容可以部署在 Elastic Cloud 上或托管在您自己的基础设施上。Elastic 管理的连接器（本机连接器）是 Elastic Cloud 上的托管服务。自管理连接器（连接器客户端）是在您的基础设施上自管理的。

端点文档

client.connector.post({ ... })

创建或更新连接器。

端点文档

client.connector.put({ ... })

取消连接器同步作业。

取消连接器同步作业，这将状态设置为正在取消，并将 cancellation_requested_at 更新为当前时间。然后，连接器服务负责将连接器同步作业的状态设置为已取消。

端点文档

client.connector.syncJobCancel({ connector_sync_job_id })

签入连接器同步作业（刷新 *last_seen*）。

端点文档

client.connector.syncJobCheckIn()

声明连接器同步作业。

client.connector.syncJobClaim()

删除连接器同步作业。

删除连接器同步作业及其关联的数据。这是一个不可恢复的破坏性操作。

端点文档

client.connector.syncJobDelete({ connector_sync_job_id })

为连接器同步作业设置错误。

端点文档

client.connector.syncJobError()

获取连接器同步作业。

端点文档

client.connector.syncJobGet({ connector_sync_job_id })

获取所有连接器同步作业。

获取有关所有存储的连接器同步作业的信息，这些作业按其创建日期升序列出。

端点文档

client.connector.syncJobList({ ... })

创建连接器同步作业。

在内部索引中创建连接器同步作业文档，并使用默认值初始化其计数器和时间戳。

端点文档

client.connector.syncJobPost({ id })

更新连接器同步作业文档中的统计信息字段。

端点文档

client.connector.syncJobUpdateStats()

激活连接器草稿过滤器。

激活连接器的有效草稿过滤。

端点文档

client.connector.updateActiveFiltering({ connector_id })

更新连接器 API 密钥 ID。

更新连接器的 api_key_id 和 api_key_secret_id 字段。您可以指定用于授权的 API 密钥的 ID 和存储 API 密钥的连接器密钥的 ID。连接器密钥 ID 仅适用于 Elastic 管理的（本机）连接器。自管理连接器（连接器客户端）不使用此字段。

端点文档

client.connector.updateApiKeyId({ connector_id })

更新连接器配置。

更新连接器文档中的配置字段。

端点文档

client.connector.updateConfiguration({ connector_id })

更新连接器错误字段。

设置连接器的错误字段。如果请求正文中提供的错误为非空，则连接器的状态将更新为错误。否则，如果错误重置为 null，则连接器状态将更新为已连接。

端点文档

client.connector.updateError({ connector_id, error })

更新连接器文档中的连接器功能。

端点文档

client.connector.updateFeatures()

更新连接器过滤。

更新连接器的草稿过滤配置，并将草稿验证状态标记为已编辑。草稿过滤在运行的 Elastic 连接器服务验证后激活。过滤属性用于配置连接器的同步规则（基本和高级）。

端点文档

client.connector.updateFiltering({ connector_id })

更新连接器草稿过滤验证。

更新连接器的草稿过滤验证信息。

client.connector.updateFilteringValidation({ connector_id, validation })

更新连接器索引名称。

更新连接器的 index_name 字段，指定存储连接器摄取的数据的索引。

端点文档

client.connector.updateIndexName({ connector_id, index_name })

更新连接器名称和描述。

端点文档

client.connector.updateName({ connector_id })

更新连接器 is_native 标志。

client.connector.updateNative({ connector_id, is_native })

更新连接器管道。

当您创建新连接器时，摄取管道的配置会使用默认设置填充。

端点文档

client.connector.updatePipeline({ connector_id, pipeline })

更新连接器计划。

端点文档

client.connector.updateScheduling({ connector_id, scheduling })

更新连接器服务类型。

端点文档

client.connector.updateServiceType({ connector_id, service_type })

更新连接器状态。

端点文档

client.connector.updateStatus({ connector_id, status })

删除悬挂索引。

如果 Elasticsearch 遇到当前集群状态中不存在的索引数据，则这些索引将被视为悬挂索引。例如，如果您在 Elasticsearch 节点脱机时删除的索引多于 cluster.indices.tombstones.size 个索引，则可能会发生这种情况。

端点文档

client.danglingIndices.deleteDanglingIndex({ index_uuid, accept_data_loss })

导入悬挂索引。

如果 Elasticsearch 遇到当前集群状态中不存在的索引数据，则这些索引将被视为悬挂索引。例如，如果您在 Elasticsearch 节点脱机时删除的索引多于 cluster.indices.tombstones.size 个索引，则可能会发生这种情况。

端点文档

client.danglingIndices.importDanglingIndex({ index_uuid, accept_data_loss })

获取悬挂索引。

如果 Elasticsearch 遇到当前集群状态中不存在的索引数据，则这些索引将被视为悬挂索引。例如，如果您在 Elasticsearch 节点脱机时删除的索引多于 cluster.indices.tombstones.size 个索引，则可能会发生这种情况。

使用此 API 列出悬挂索引，然后您可以导入或删除它们。

端点文档

client.danglingIndices.listDanglingIndices()

删除富集策略。删除现有的富集策略及其富集索引。

端点文档

client.enrich.deletePolicy({ name })

运行富集策略。为现有富集策略创建富集索引。

端点文档

client.enrich.executePolicy({ name })

获取富集策略。返回有关富集策略的信息。

端点文档

client.enrich.getPolicy({ ... })

创建富集策略。创建一个富集策略。

端点文档

client.enrich.putPolicy({ name })

获取富集统计信息。返回富集协调器统计信息以及有关当前正在执行的富集策略的信息。

端点文档

client.enrich.stats()

删除异步 EQL 搜索。删除异步 EQL 搜索或存储的同步 EQL 搜索。该 API 还会删除搜索结果。

端点文档

client.eql.delete({ id })

获取异步 EQL 搜索结果。获取异步 EQL 搜索或存储的同步 EQL 搜索的当前状态和可用结果。

端点文档

client.eql.get({ id })

获取异步 EQL 状态。获取异步 EQL 搜索或存储的同步 EQL 搜索的当前状态，但不返回结果。

端点文档

client.eql.getStatus({ id })

获取 EQL 搜索结果。返回事件查询语言 (EQL) 查询的搜索结果。EQL 假定数据流或索引中的每个文档都对应一个事件。

端点文档

client.eql.search({ index, query })

异步执行 ESQL 请求

端点文档

client.esql.asyncQuery()

检索之前提交的异步查询请求的结果（给定其 ID）。

端点文档

client.esql.asyncQueryGet()

运行 ES|QL 查询。获取 ES|QL (Elasticsearch 查询语言) 查询的搜索结果。

端点文档

client.esql.query({ query })

获取可以使用 feature_states 字段在创建快照时包含在快照中的功能列表

端点文档

client.features.getFeatures()

重置功能的内部状态，通常通过删除系统索引

端点文档

client.features.resetFeatures()

返回索引的当前全局检查点。此 API 专为 Fleet Server 项目内部使用而设计。

端点文档

client.fleet.globalCheckpoints({ index })

使用单个 API 请求执行多个[fleet 搜索](https://elastic.ac.cn/guide/en/elasticsearch/reference/current/fleet-search.html)。该 API 的结构与[多重搜索](https://elastic.ac.cn/guide/en/elasticsearch/reference/current/search-multi-search.html) API 相同。但是，与 fleet 搜索 API 类似，它支持 wait_for_checkpoints 参数。

client.fleet.msearch({ ... })

fleet 搜索 API 的目的是提供一个搜索 API，只有在提供的检查点已被处理并且在 Elasticsearch 中对搜索可见后，才会执行搜索。

client.fleet.search({ index })

浏览图形分析。提取和汇总有关 Elasticsearch 数据流或索引中的文档和术语的信息。了解此 API 行为的最简单方法是使用图形 UI 来浏览连接。对 _explore API 的初始请求包含一个种子查询，该查询标识感兴趣的文档并指定定义要在图中包含的顶点和连接的字段。后续请求使您可以从一个或多个感兴趣的顶点向外扩展。您可以排除已返回的顶点。

端点文档

client.graph.explore({ index })

删除指定的生命周期策略定义。您不能删除当前正在使用的策略。如果该策略正用于管理任何索引，则请求将失败并返回错误。

端点文档

client.ilm.deleteLifecycle({ policy })

检索有关索引当前生命周期状态的信息，例如当前正在执行的阶段、操作和步骤。显示索引进入每个阶段的时间、正在运行的阶段的定义以及有关任何失败的信息。

端点文档

client.ilm.explainLifecycle({ index })

检索生命周期策略。

端点文档

client.ilm.getLifecycle({ ... })

检索当前索引生命周期管理 (ILM) 状态。

端点文档

client.ilm.getStatus()

将索引、ILM 策略以及旧的、可组合的和组件模板从使用自定义节点属性和基于属性的分配过滤器切换为使用数据层，并可以选择删除一个旧的索引模板。+ 使用节点角色使 ILM 能够自动在数据层之间移动索引。

端点文档

client.ilm.migrateToDataTiers({ ... })

手动将索引移动到指定的步骤并执行该步骤。

端点文档

client.ilm.moveToStep({ index, current_step, next_step })

创建生命周期策略。如果指定的策略存在，则会替换该策略，并且策略版本会递增。

端点文档

client.ilm.putLifecycle({ policy })

删除分配的生命周期策略并停止管理指定的索引

端点文档

client.ilm.removePolicy({ index })

重试执行处于 ERROR 步骤的索引的策略。

端点文档

client.ilm.retry({ index })

启动索引生命周期管理 (ILM) 插件。

端点文档

client.ilm.start({ ... })

停止所有生命周期管理操作并停止索引生命周期管理 (ILM) 插件

端点文档

client.ilm.stop({ ... })