›

API 参考

API 参考编辑

批量操作编辑

允许在单个请求中执行多个索引/更新/删除操作。

client.bulk({ ... })

参数编辑

请求（对象）
- index （可选，字符串）：要对其执行批量操作的数据流、索引或索引别名的名称。
- operations （可选，{ index, create, update, delete } | { detect_noop, doc, doc_as_upsert, script, scripted_upsert, _source, upsert } | 对象数组）
- pipeline （可选，字符串）：用于预处理传入文档的管道 ID。如果索引指定了默认摄取管道，则将该值设置为 _none 会禁用此请求的默认摄取管道。如果配置了最终管道，则无论此参数的值如何，它都将始终运行。
- refresh （可选，枚举（true | false | "wait_for"））：如果为 true，Elasticsearch 会刷新受影响的分片以使此操作对搜索可见，如果为 wait_for，则等待刷新以使此操作对搜索可见，如果为 false，则不对刷新执行任何操作。有效值：true、false、wait_for。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- _source （可选，布尔值 | 字符串 | 字符串数组）：true 或 false 表示返回或不返回 _source 字段，或者是要返回的字段列表。
- _source_excludes （可选，字符串 | 字符串数组）：要从响应中排除的源字段列表。
- _source_includes （可选，字符串 | 字符串数组）：要包含在响应中的源字段列表。
- timeout （可选，字符串 | -1 | 0）：每个操作等待以下操作的时间段：自动索引创建、动态映射更新、等待活动分片。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。
- require_alias （可选，布尔值）：如果为 true，则请求的操作必须针对索引别名。

清除滚动编辑

显式清除滚动的搜索上下文。

端点文档

client.clearScroll({ ... })

参数编辑

请求（对象）
- scroll_id （可选，字符串 | 字符串数组）：要清除的滚动 ID 列表。要清除所有滚动 ID，请使用 _all。

关闭时间点编辑

关闭时间点

端点文档

client.closePointInTime({ id })

计数编辑

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

端点文档

client.count({ ... })

参数编辑

请求（对象）
- index （可选，字符串 | 字符串数组）：要搜索的数据流、索引和别名列表。支持通配符 (*)。要搜索所有数据流和索引，请省略此参数或使用 * 或 _all。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })：使用查询 DSL 定义搜索定义。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- analyzer （可选，字符串）：用于查询字符串的分析器。此参数只能在指定了 q 查询字符串参数时使用。
- analyze_wildcard （可选，布尔值）：如果为 true，则分析通配符和前缀查询。此参数只能在指定了 q 查询字符串参数时使用。
- default_operator （可选，枚举（"and" | "or"））：查询字符串查询的默认运算符：AND 或 OR。此参数只能在指定了 q 查询字符串参数时使用。
- df （可选，字符串）：在查询字符串中未给出字段前缀时用作默认值的字段。此参数只能在指定了 q 查询字符串参数时使用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）数组）：通配符模式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。
- ignore_throttled （可选，布尔值）：如果为 true，则在冻结时忽略具体的、已扩展的或已设置别名的索引。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- lenient （可选，布尔值）：如果为 true，则将忽略查询字符串中基于格式的查询失败（例如，向数字字段提供文本）。
- min_score （可选，数字）：设置文档必须包含的最小 _score 值才能包含在结果中。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- terminate_after （可选，数字）：要为每个分片收集的最大文档数。如果查询达到此限制，Elasticsearch 将提前终止查询。Elasticsearch 在排序之前收集文档。
- q （可选，字符串）：使用 Lucene 查询字符串语法的查询。

创建编辑

在索引中创建新文档。

当索引中已存在具有相同 ID 的文档时，返回 409 响应。

端点文档

client.create({ id, index })

参数编辑

请求（对象）
- id （字符串）：文档的唯一标识符。
- index （字符串）：要定位的数据流或索引的名称。如果目标不存在且与具有 data_stream 定义的索引模板的名称或通配符 (*) 模式匹配，则此请求将创建数据流。如果目标不存在且与数据流模板不匹配，则此请求将创建索引。
- document （可选，对象）：文档。
- pipeline （可选，字符串）：用于预处理传入文档的管道 ID。如果索引指定了默认摄取管道，则将该值设置为 _none 会禁用此请求的默认摄取管道。如果配置了最终管道，则无论此参数的值如何，它都将始终运行。
- refresh （可选，枚举（true | false | "wait_for"））：如果为 true，Elasticsearch 会刷新受影响的分片以使此操作对搜索可见，如果为 wait_for，则等待刷新以使此操作对搜索可见，如果为 false，则不对刷新执行任何操作。有效值：true、false、wait_for。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- timeout （可选，字符串 | -1 | 0）：请求等待以下操作的时间段：自动索引创建、动态映射更新、等待活动分片。
- version （可选，数字）：用于并发控制的显式版本号。指定的版本必须与文档的当前版本匹配，请求才能成功。
- version_type （可选，枚举（"internal" | "external" | "external_gte" | "force"））：特定版本类型：external、external_gte。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

删除编辑

从索引中删除文档。

端点文档

client.delete({ id, index })

参数编辑

请求（对象）
- id （字符串）：文档的唯一标识符。
- index （字符串）：目标索引的名称。
- if_primary_term （可选，数字）：仅当文档具有此主期限时才执行操作。
- if_seq_no （可选，数字）：仅当文档具有此序列号时才执行操作。
- refresh （可选，枚举（true | false | "wait_for"））：如果为 true，Elasticsearch 会刷新受影响的分片以使此操作对搜索可见，如果为 wait_for，则等待刷新以使此操作对搜索可见，如果为 false，则不对刷新执行任何操作。有效值：true、false、wait_for。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- timeout （可选，字符串 | -1 | 0）：等待活动分片的期限。
- version （可选，数字）：用于并发控制的显式版本号。指定的版本必须与文档的当前版本匹配，请求才能成功。
- version_type （可选，枚举（"internal" | "external" | "external_gte" | "force"））：特定版本类型：external、external_gte。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

按查询删除编辑

删除与提供的查询匹配的文档。

端点文档

client.deleteByQuery({ index })

参数编辑

请求（对象）
- index （字符串 | 字符串数组）：要搜索的数据流、索引和别名列表。支持通配符 (*)。要搜索所有数据流或索引，请省略此参数或使用 * 或 _all。
- max_docs （可选，数字）：要删除的最大文档数。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：使用查询 DSL 指定要删除的文档。
- slice （可选，{ field, id, max }）：使用提供的切片 ID 和切片总数手动切片请求。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅指向缺少或关闭的索引，则请求将返回错误。即使请求指向其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则指向 foo*,bar* 的请求将返回错误。
- analyzer （可选，字符串）：用于查询字符串的分析器。
- analyze_wildcard （可选，布尔值）：如果为 true，则分析通配符和前缀查询。
- conflicts （可选，枚举（"abort" | "proceed"））：如果按查询删除遇到版本冲突，该怎么办：abort 或 proceed。
- default_operator （可选，枚举（"and" | "or"））：查询字符串查询的默认运算符：AND 或 OR。
- df （可选，字符串）：在查询字符串中未给出字段前缀时用作默认值的字段。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- from （可选，数字）：起始偏移量（默认值：0）
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- lenient （可选，布尔值）：如果为 true，则将忽略查询字符串中基于格式的查询失败（例如，向数字字段提供文本）。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- refresh （可选，布尔值）：如果为 true，则 Elasticsearch 在请求完成后刷新参与按查询删除的所有分片。
- request_cache （可选，布尔值）：如果为 true，则对此请求使用请求缓存。默认为索引级设置。
- requests_per_second （可选，浮点数）：此请求在每秒子请求中的限制。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- q （可选，字符串）：使用 Lucene 查询字符串语法的查询。
- scroll （可选，字符串 | -1 | 0）：保留滚动搜索上下文的期限。
- scroll_size （可选，数字）：为操作提供支持的滚动请求的大小。
- search_timeout （可选，字符串 | -1 | 0）：每个搜索请求的显式超时。默认为无超时。
- search_type （可选，枚举（"query_then_fetch" | "dfs_query_then_fetch"））：搜索操作的类型。可用选项：query_then_fetch、dfs_query_then_fetch。
- slices （可选，数字 | 枚举（"auto"））：此任务应划分成的切片数。
- sort （可选，字符串[]）：<字段>:<方向> 对的列表。
- stats （可选，字符串[]）：用于日志记录和统计目的的请求的特定 tag。
- terminate_after （可选，数字）：要为每个分片收集的最大文档数。如果查询达到此限制，Elasticsearch 会提前终止查询。Elasticsearch 在排序之前收集文档。请谨慎使用。Elasticsearch 将此参数应用于处理请求的每个分片。如果可能，让 Elasticsearch 自动执行提前终止。避免为针对跨多个数据层的备份索引上的数据流的请求指定此参数。
- timeout （可选，字符串 | -1 | 0）：每个删除请求等待活动分片的期限。
- version （可选，布尔值）：如果为 true，则返回文档版本作为匹配结果的一部分。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。
- wait_for_completion （可选，布尔值）：如果为 true，则请求将阻塞，直到操作完成。

delete_by_query_rethrottleedit

更改特定按查询删除操作的每秒请求数。

端点文档

client.deleteByQueryRethrottle({ task_id })

参数edit

请求（对象）
- task_id （字符串 | 数字）：任务的 ID。
- requests_per_second （可选，浮点数）：此请求在每秒子请求中的限制。

delete_scriptedit

删除脚本。

端点文档

client.deleteScript({ id })

参数edit

请求（对象）
- id （字符串）：存储的脚本或搜索模板的标识符。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

existsedit

返回有关文档是否存在于索引中的信息。

端点文档

client.exists({ id, index })

参数edit

请求（对象）
- id （字符串）：文档的标识符。
- index （字符串）：数据流、索引和别名的列表。支持通配符 (*)。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- realtime （可选，布尔值）：如果为 true，则请求是实时的，而不是近实时的。
- refresh （可选，布尔值）：如果为 true，则 Elasticsearch 在请求完成后刷新参与按查询删除的所有分片。
- routing （可选，字符串）：定位指定的主分片。
- _source （可选，布尔值 | 字符串 | 字符串数组）：true 或 false 表示返回或不返回 _source 字段，或者是要返回的字段列表。
- _source_excludes （可选，字符串 | 字符串[]）：要在响应中排除的源字段列表。
- _source_includes （可选，字符串 | 字符串数组）：要包含在响应中的源字段列表。
- stored_fields （可选，字符串 | 字符串[]）：要作为匹配结果的一部分返回的存储字段列表。如果未指定任何字段，则响应中不包含任何存储字段。如果指定了此字段，则 _source 参数默认为 false。
- version （可选，数字）：用于并发控制的显式版本号。指定的版本必须与文档的当前版本匹配，请求才能成功。
- version_type （可选，枚举（"internal" | "external" | "external_gte" | "force"））：特定版本类型：external、external_gte。

exists_sourceedit

返回有关文档源是否存在于索引中的信息。

端点文档

client.existsSource({ id, index })

参数edit

请求（对象）
- id （字符串）：文档的标识符。
- index （字符串）：数据流、索引和别名的列表。支持通配符 (*)。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- realtime （可选，布尔值）：如果为 true，则请求是实时的，而不是近实时的。
- refresh （可选，布尔值）：如果为 true，则 Elasticsearch 在请求完成后刷新参与按查询删除的所有分片。
- routing （可选，字符串）：定位指定的主分片。
- _source （可选，布尔值 | 字符串 | 字符串数组）：true 或 false 表示返回或不返回 _source 字段，或者是要返回的字段列表。
- _source_excludes （可选，字符串 | 字符串[]）：要在响应中排除的源字段列表。
- _source_includes （可选，字符串 | 字符串数组）：要包含在响应中的源字段列表。
- version （可选，数字）：用于并发控制的显式版本号。指定的版本必须与文档的当前版本匹配，请求才能成功。
- version_type （可选，枚举（"internal" | "external" | "external_gte" | "force"））：特定版本类型：external、external_gte。

explainedit

返回有关为什么特定匹配（或不匹配）查询的信息。

端点文档

client.explain({ id, index })

参数edit

请求（对象）
- id （字符串）：定义文档 ID。
- index （字符串）：用于限制请求的索引名称。此参数只能提供一个索引名称。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })：使用查询 DSL 定义搜索定义。
- analyzer （可选，字符串）：用于查询字符串的分析器。此参数只能在指定了 q 查询字符串参数时使用。
- analyze_wildcard （可选，布尔值）：如果为 true，则分析通配符和前缀查询。
- default_operator （可选，枚举（"and" | "or"））：查询字符串查询的默认运算符：AND 或 OR。
- df （可选，字符串）：在查询字符串中未给出字段前缀时用作默认值的字段。
- lenient （可选，布尔值）：如果为 true，则将忽略查询字符串中基于格式的查询失败（例如，向数字字段提供文本）。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- _source （可选，布尔值 | 字符串 | 字符串[]）：True 或 false 表示返回或不返回 _source 字段，或要返回的字段列表。
- _source_excludes （可选，字符串 | 字符串数组）：要从响应中排除的源字段列表。
- _source_includes （可选，字符串 | 字符串数组）：要包含在响应中的源字段列表。
- stored_fields （可选，字符串 | 字符串[]）：要在响应中返回的存储字段列表。
- q （可选，字符串）：使用 Lucene 查询字符串语法的查询。

field_capsedit

返回有关多个索引中字段功能的信息。

端点文档

client.fieldCaps({ ... })

参数edit

请求（对象）
- index （可选，字符串 | 字符串[]）：用于限制请求的数据流、索引和别名的列表。支持通配符 (*)。要定位所有数据流和索引，请省略此参数或使用 * 或 _all。
- fields （可选，字符串 | 字符串[]）：要检索其功能的字段列表。支持通配符 (*) 表达式。
- index_filter （可选，{ 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：如果提供的查询在每个分片上都重写为 match_none，则允许过滤索引。
- runtime_mappings（可选，Record<string, { fetch_fields, format, input_field, target_field, target_index, script, type }>）：在请求中定义临时运行时字段，类似于在搜索请求中完成的方式。这些字段仅作为查询的一部分存在，并且优先于索引映射中定义的同名字段。
- allow_no_indices（可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅定位到缺失或已关闭的索引，则请求返回错误。即使请求定位到其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则定位到 foo*,bar* 的请求将返回错误。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）数组）：通配符模式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。
- ignore_unavailable（可选，布尔值）：如果为 true，则缺失或已关闭的索引不会包含在响应中。
- include_unmapped（可选，布尔值）：如果为 true，则未映射的字段将包含在响应中。
- filters（可选，字符串）：一组可选的过滤器：可以包括 +metadata,-metadata,-nested,-multifield,-parent
- types（可选，字符串数组）：仅返回列表中具有其中一种类型的字段的结果
- include_empty_fields（可选，布尔值）：如果为 false，则空字段不会包含在响应中。

获取编辑

返回文档。

端点文档

client.get({ id, index })

参数编辑

请求（对象）
- id（字符串）：文档的唯一标识符。
- index（字符串）：包含文档的索引的名称。
- force_synthetic_source（可选，布尔值）：此请求是否应强制使用合成 _source？使用此选项可测试映射是否支持合成 _source 并了解最坏情况下的性能。启用此选项后，获取的速度将比在索引中本地启用合成源的速度慢。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- realtime （可选，布尔值）：如果为 true，则请求是实时的，而不是近实时的。
- refresh（可选，布尔值）：如果为 true，则 Elasticsearch 会刷新受影响的分片，以使此操作对搜索可见。如果为 false，则不对刷新执行任何操作。
- routing （可选，字符串）：定位指定的主分片。
- _source（可选，布尔值 | 字符串 | 字符串数组）：True 或 false 表示返回或不返回 _source 字段，或者是要返回的字段列表。
- _source_excludes （可选，字符串 | 字符串[]）：要在响应中排除的源字段列表。
- _source_includes （可选，字符串 | 字符串数组）：要包含在响应中的源字段列表。
- stored_fields （可选，字符串 | 字符串[]）：要作为匹配结果的一部分返回的存储字段列表。如果未指定任何字段，则响应中不包含任何存储字段。如果指定了此字段，则 _source 参数默认为 false。
- version （可选，数字）：用于并发控制的显式版本号。指定的版本必须与文档的当前版本匹配，请求才能成功。
- version_type（可选，枚举（"internal" | "external" | "external_gte" | "force"））：特定版本类型：internal、external、external_gte。

获取脚本编辑

返回脚本。

端点文档

client.getScript({ id })

参数编辑

请求（对象）
- id （字符串）：存储的脚本或搜索模板的标识符。
- master_timeout（可选，字符串 | -1 | 0）：指定连接到主节点的超时时间

获取脚本上下文编辑

返回所有脚本上下文。

端点文档

client.getScriptContext()

获取脚本语言编辑

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

端点文档

client.getScriptLanguages()

获取源编辑

返回文档的源。

端点文档

client.getSource({ id, index })

参数编辑

请求（对象）
- id（字符串）：文档的唯一标识符。
- index（字符串）：包含文档的索引的名称。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- realtime（可选，布尔值）：布尔值）如果为 true，则请求是实时请求，而不是近实时请求。
- refresh（可选，布尔值）：如果为 true，则 Elasticsearch 会刷新受影响的分片，以使此操作对搜索可见。如果为 false，则不对刷新执行任何操作。
- routing （可选，字符串）：定位指定的主分片。
- _source（可选，布尔值 | 字符串 | 字符串数组）：True 或 false 表示返回或不返回 _source 字段，或者是要返回的字段列表。
- _source_excludes （可选，字符串 | 字符串[]）：要在响应中排除的源字段列表。
- _source_includes （可选，字符串 | 字符串数组）：要包含在响应中的源字段列表。
- stored_fields（可选，字符串 | 字符串数组）
- version （可选，数字）：用于并发控制的显式版本号。指定的版本必须与文档的当前版本匹配，请求才能成功。
- version_type（可选，枚举（"internal" | "external" | "external_gte" | "force"））：特定版本类型：internal、external、external_gte。

健康状况报告编辑

返回集群的健康状况。

端点文档

client.healthReport({ ... })

参数编辑

请求（对象）
- feature（可选，字符串 | 字符串数组）：集群的一项功能，由顶级健康状况报告 API 返回。
- timeout（可选，字符串 | -1 | 0）：显式操作超时时间。
- verbose（可选，布尔值）：选择加入以获取有关系统健康状况的更多信息。
- size（可选，数字）：限制健康状况报告 API 返回的受影响资源的数量。

索引编辑

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

端点文档

client.index({ index })

参数编辑

请求（对象）
- index（字符串）：要定位的数据流或索引的名称。
- id（可选，字符串）：文档的唯一标识符。
- document （可选，对象）：文档。
- if_primary_term （可选，数字）：仅当文档具有此主期限时才执行操作。
- if_seq_no （可选，数字）：仅当文档具有此序列号时才执行操作。
- op_type（可选，枚举（"index" | "create"））：设置为 create 仅在文档不存在时才对其进行索引（如果不存在则放置）。如果具有指定的 _id 的文档已存在，则索引操作将失败。与使用 <index>/_create 端点相同。有效值：index、create。如果指定了文档 ID，则默认为 index。否则，默认为 create。
- pipeline （可选，字符串）：用于预处理传入文档的管道 ID。如果索引指定了默认摄取管道，则将该值设置为 _none 会禁用此请求的默认摄取管道。如果配置了最终管道，则无论此参数的值如何，它都将始终运行。
- refresh （可选，枚举（true | false | "wait_for"））：如果为 true，Elasticsearch 会刷新受影响的分片以使此操作对搜索可见，如果为 wait_for，则等待刷新以使此操作对搜索可见，如果为 false，则不对刷新执行任何操作。有效值：true、false、wait_for。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- timeout （可选，字符串 | -1 | 0）：请求等待以下操作的时间段：自动索引创建、动态映射更新、等待活动分片。
- version （可选，数字）：用于并发控制的显式版本号。指定的版本必须与文档的当前版本匹配，请求才能成功。
- version_type （可选，枚举（"internal" | "external" | "external_gte" | "force"））：特定版本类型：external、external_gte。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。
- require_alias（可选，布尔值）：如果为 true，则目标必须是索引别名。

信息编辑

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

端点文档

client.info()

knn 搜索编辑

执行 kNN 搜索。

端点文档

client.knnSearch({ index, knn })

参数编辑

请求（对象）
- index（字符串 | 字符串数组）：要搜索的索引名称列表；使用 _all 或对所有索引执行操作
- knn（{ field, query_vector, k, num_candidates }）：要执行的 kNN 查询
- _source（可选，布尔值 | { excludes, includes }）：指示为匹配文档返回哪些源字段。这些字段在搜索响应的 hits._source 属性中返回。
- docvalue_fields（可选，{ field, format, include_unmapped }[]）：请求返回与响应的 hits.fields 属性中这些模式匹配的字段名称的文档值。接受通配符 (*) 模式。
- stored_fields（可选，字符串 | 字符串数组）：要作为命中的一部分返回的存储字段列表。如果未指定任何字段，则响应中不包含任何存储字段。如果指定了此字段，则 _source 参数默认为 false。您可以传递 _source: true 以在搜索响应中同时返回源字段和存储字段。
- fields（可选，字符串 | 字符串数组）：请求返回与响应的 hits.fields 属性中这些模式匹配的字段名称的值。接受通配符 (*) 模式。
- filter（可选，{ 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type } | { 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }[]）：用于过滤可以匹配的文档的查询。kNN 搜索将返回也与此过滤器匹配的前 k 个文档。该值可以是单个查询或查询列表。如果未提供 filter，则允许所有文档匹配。
- routing（可选，字符串）：特定路由值列表

多重获取编辑

允许在一个请求中获取多个文档。

端点文档

client.mget({ ... })

参数编辑

请求（对象）
- index（可选，字符串）：指定 ids 时，或 docs 数组中的文档未指定索引时，要从中检索文档的索引的名称。
- docs（可选，{ _id, _index, routing, _source, stored_fields, version, version_type }[]）：您要检索的文档。如果请求 URI 中未指定索引，则为必需项。
- ids（可选，字符串 | 字符串数组）：您要检索的文档的 ID。在请求 URI 中指定了索引时允许使用。
- force_synthetic_source（可选，布尔值）：此请求是否应强制使用合成 _source？使用此选项可测试映射是否支持合成 _source 并了解最坏情况下的性能。启用此选项后，获取的速度将比在索引中本地启用合成源的速度慢。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- realtime （可选，布尔值）：如果为 true，则请求是实时的，而不是近实时的。
- refresh（可选，布尔值）：如果为 true，则请求会在检索文档之前刷新相关分片。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- _source （可选，布尔值 | 字符串 | 字符串[]）：True 或 false 表示返回或不返回 _source 字段，或要返回的字段列表。
- _source_excludes（可选，字符串 | 字符串数组）：要从响应中排除的源字段列表。您还可以使用此参数从 _source_includes 查询参数中指定的子集中排除字段。
- _source_includes（可选，字符串 | 字符串数组）：要包含在响应中的源字段列表。如果指定了此参数，则仅返回这些源字段。您可以使用 _source_excludes 查询参数从此子集中排除字段。如果 _source 参数为 false，则此参数将被忽略。
- stored_fields（可选，字符串 | 字符串数组）：如果为 true，则检索存储在索引中的文档字段，而不是文档 _source。

msearch编辑

允许在一个请求中执行多个搜索操作。

端点文档

client.msearch({ ... })

参数编辑

请求（对象）
- index（可选，string | string[]）：要搜索的数据流、索引和索引别名列表。
- searches （可选，{ allow_no_indices, expand_wildcards, ignore_unavailable, index, preference, request_cache, routing, search_type, ccs_minimize_roundtrips, allow_partial_search_results, ignore_throttled } | { aggregations, collapse, query, explain, ext, stored_fields, docvalue_fields, knn, from, highlight, indices_boost, min_score, post_filter, profile, rescore, script_fields, search_after, size, sort, _source, fields, terminate_after, stats, timeout, track_scores, track_total_hits, version, runtime_mappings, seq_no_primary_term, pit, suggest }[]）
- allow_no_indices（可选，boolean）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。例如，如果一个索引以 foo 开头但没有索引以 bar 开头，则针对 foo*,bar* 的请求将返回错误。
- ccs_minimize_roundtrips（可选，boolean）：如果为 true，则针对跨集群搜索请求，将最小化协调节点与远程集群之间的网络往返次数。
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：通配符表达式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。
- ignore_throttled（可选，boolean）：如果为 true，则在冻结时将忽略具体的、已扩展的或已设置别名的索引。
- ignore_unavailable（可选，boolean）：如果为 true，则响应中不包括缺失或关闭的索引。
- max_concurrent_searches（可选，number）：多重搜索 API 可以执行的最大并发搜索数。
- max_concurrent_shard_requests（可选，number）：每个子搜索请求在每个节点上执行的最大并发分片请求数。
- pre_filter_shard_size（可选，number）：定义一个阈值，如果搜索请求扩展到的分片数超过该阈值，则强制执行预过滤往返，以便根据查询重写来预过滤搜索分片。如果例如分片无法根据其重写方法匹配任何文档（例如，如果日期过滤器是匹配的强制性条件，但分片边界和查询是不相交的），则此过滤器往返可以显著限制分片数。
- rest_total_hits_as_int（可选，boolean）：如果为 true，则在响应中将 hits.total 作为整数返回。默认为 false，它返回一个对象。
- routing（可选，string）：用于将搜索操作路由到特定分片的自定义路由值。
- search_type（可选，Enum("query_then_fetch" | "dfs_query_then_fetch"))：指示在对返回的文档进行评分时是否应使用全局词条和文档频率。
- typed_keys（可选，boolean）：指定在响应中聚合和建议器名称是否应以其各自的类型作为前缀。

msearch_template编辑

允许在一个请求中执行多个搜索模板操作。

端点文档

client.msearchTemplate({ ... })

参数编辑

请求（对象）
- index（可选，string | string[]）：要搜索的数据流、索引和别名列表。支持通配符 (*)。要搜索集群中的所有数据流和索引，请省略此参数或使用 *。
- search_templates （可选，{ allow_no_indices, expand_wildcards, ignore_unavailable, index, preference, request_cache, routing, search_type, ccs_minimize_roundtrips, allow_partial_search_results, ignore_throttled } | { aggregations, collapse, query, explain, ext, stored_fields, docvalue_fields, knn, from, highlight, indices_boost, min_score, post_filter, profile, rescore, script_fields, search_after, size, sort, _source, fields, terminate_after, stats, timeout, track_scores, track_total_hits, version, runtime_mappings, seq_no_primary_term, pit, suggest }[]）
- ccs_minimize_roundtrips（可选，boolean）：如果为 true，则针对跨集群搜索请求，将最小化网络往返次数。
- max_concurrent_searches（可选，number）：API 可以运行的最大并发搜索数。
- search_type （可选，枚举（"query_then_fetch" | "dfs_query_then_fetch"））：搜索操作的类型。可用选项：query_then_fetch、dfs_query_then_fetch。
- rest_total_hits_as_int（可选，boolean）：如果为 true，则响应将 hits.total 作为整数返回。如果为 false，则将 hits.total 作为对象返回。
- typed_keys（可选，boolean）：如果为 true，则响应将以聚合和建议器各自的类型作为前缀。

mtermvectors编辑

在一个请求中返回多个词条向量。

端点文档

client.mtermvectors({ ... })

参数编辑

请求（对象）
- index（可选，string）：包含文档的索引名称。
- docs（可选，{ _id, _index, routing, _source, stored_fields, version, version_type }[]）：现有或人工文档的数组。
- ids（可选，string[]）：如果文档位于同一索引中，则用于通过其 ID 指定文档的简化语法。
- fields（可选，string | string[]）：要包含在统计信息中的字段的列表或通配符表达式。用作默认列表，除非在 completion_fields 或 fielddata_fields 参数中提供了特定的字段列表。
- field_statistics（可选，boolean）：如果为 true，则响应将包括文档计数、文档频率总和和词条频率总和。
- offsets（可选，boolean）：如果为 true，则响应将包括词条偏移量。
- payloads（可选，boolean）：如果为 true，则响应将包括词条有效负载。
- positions（可选，boolean）：如果为 true，则响应将包括词条位置。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- realtime （可选，布尔值）：如果为 true，则请求是实时的，而不是近实时的。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- term_statistics（可选，boolean）：如果为 true，则响应将包括词条频率和文档频率。
- version（可选，number）：如果为 true，则返回文档版本作为匹配的一部分。
- version_type（可选，Enum("internal" | "external" | "external_gte" | "force"))：特定版本类型。

open_point_in_time编辑

打开一个时间点，可以在后续搜索中使用

端点文档

client.openPointInTime({ index, keep_alive })

参数编辑

请求（对象）
- index (string | string[])：要打开时间点的索引名称列表；使用 _all 或空字符串对所有索引执行操作
- keep_alive (string | -1 | 0)：延长相应时间点的生存时间。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。

ping编辑

返回集群是否正在运行。

端点文档

client.ping()

put_script编辑

创建或更新脚本。

端点文档

client.putScript({ id, script })

参数编辑

请求（对象）
- id (string)：存储的脚本或搜索模板的标识符。在集群内必须是唯一的。
- script ({ lang, options, source })：包含脚本或搜索模板、其参数及其语言。
- context（可选，string）：脚本或搜索模板应在其中运行的上下文。为防止错误，API 会立即在此上下文中编译脚本或模板。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

rank_eval编辑

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

端点文档

client.rankEval({ requests })

参数编辑

请求（对象）
- requests ({ id, request, ratings, template_id, params }[])：一组典型搜索请求及其提供的评分。
- index（可选，string | string[]）：用于限制请求的数据流、索引和索引别名列表。支持通配符 (*) 表达式。要定位集群中的所有数据流和索引，请省略此参数或使用 _all 或 *。
- metric（可选，{ precision, recall, mean_reciprocal_rank, dcg, expected_reciprocal_rank })：要计算的评估指标的定义。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅指向缺少或关闭的索引，则请求将返回错误。即使请求指向其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则指向 foo*,bar* 的请求将返回错误。
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：是否将通配符表达式扩展到打开、关闭或同时打开和关闭的具体索引。
- ignore_unavailable（可选，布尔值）：如果为 true，则缺失或已关闭的索引不会包含在响应中。
- search_type（可选，string）：搜索操作类型

reindex编辑

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

端点文档

client.reindex({ dest, source })

参数编辑

请求（对象）
- dest ({ index, op_type, pipeline, routing, version_type }): 复制的目标位置。
- source ({ index, query, remote, size, slice, sort, _source, runtime_mappings }): 复制的来源。
- conflicts (可选, 枚举("abort" | "proceed")): 设置为 proceed 可以在出现冲突时继续重建索引。
- max_docs (可选, 数字): 要重建索引的最大文档数。
- script (可选, { lang, options, source } | { id }): 用于在重建索引时更新文档源或元数据的脚本。
- size (可选, 数字)
- refresh (可选, 布尔值): 如果为 true，则请求会刷新受影响的分片，以便搜索操作可以看到此操作。
- requests_per_second (可选, 浮点数): 此请求在每秒子请求中的限制。默认为无限制。
- scroll (可选, 字符串 | -1 | 0): 指定对滚动搜索维护索引一致视图的时间长度。
- slices (可选, 数字 | 枚举("auto")): 此任务应划分的切片数。默认为 1 个切片，这意味着该任务不会被切片成子任务。
- timeout (可选, 字符串 | -1 | 0): 每次索引等待自动索引创建、动态映射更新和等待活动分片的时长。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。
- wait_for_completion （可选，布尔值）：如果为 true，则请求将阻塞，直到操作完成。
- require_alias（可选，布尔值）：如果为 true，则目标必须是索引别名。

reindex_rethrottle编辑

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

端点文档

client.reindexRethrottle({ task_id })

参数编辑

请求（对象）
- task_id (字符串): 任务的标识符。
- requests_per_second （可选，浮点数）：此请求在每秒子请求中的限制。

render_search_template编辑

允许使用 Mustache 语言预渲染搜索定义。

端点文档

client.renderSearchTemplate({ ... })

参数编辑

请求（对象）
- id (可选, 字符串): 要渲染的搜索模板的 ID。如果未指定 source，则此参数或 id 请求正文参数是必需的。
- file (可选, 字符串)
- params (可选, 记录<字符串, 用户定义的值>): 用于替换模板中 Mustache 变量的键值对。键是变量名。值是变量值。
- source (可选, 字符串): 内联搜索模板。支持与搜索 API 的请求正文相同的参数。这些参数也支持 Mustache 变量。如果未指定 id 或 <templated-id>，则此参数是必需的。

scripts_painless_execute编辑

允许执行任意脚本并返回结果

端点文档

client.scriptsPainlessExecute({ ... })

参数编辑

请求（对象）
- context (可选, 字符串): 脚本应在其中运行的上下文。
- context_setup (可选, { document, index, query }): context 的附加参数。
- script (可选, { lang, options, source }): 要执行的 Painless 脚本。

scroll编辑

允许从单个搜索请求中检索大量结果。

端点文档

client.scroll({ scroll_id })

参数编辑

请求（对象）
- scroll_id (字符串): 搜索的滚动 ID。
- scroll （可选，字符串 | -1 | 0）：保留滚动搜索上下文的期限。
- rest_total_hits_as_int (可选, 布尔值): 如果为 true，则 API 响应的 hit.total 属性作为整数返回。如果为 false，则 API 响应的 hit.total 属性作为对象返回。

search编辑

返回与查询匹配的结果。

端点文档

client.search({ ... })

参数编辑

请求（对象）
- index （可选，字符串 | 字符串数组）：要搜索的数据流、索引和别名列表。支持通配符 (*)。要搜索所有数据流和索引，请省略此参数或使用 * 或 _all。
- aggregations (可选, 记录<字符串, { aggregations, meta, adjacency_matrix, auto_date_histogram, avg, avg_bucket, boxplot, bucket_script, bucket_selector, bucket_sort, bucket_count_ks_test, bucket_correlation, cardinality, categorize_text, children, composite, cumulative_cardinality, cumulative_sum, date_histogram, date_range, derivative, diversified_sampler, extended_stats, extended_stats_bucket, frequent_item_sets, filter, filters, geo_bounds, geo_centroid, geo_distance, geohash_grid, geo_line, geotile_grid, geohex_grid, global, histogram, ip_range, ip_prefix, inference, line, matrix_stats, max, max_bucket, median_absolute_deviation, min, min_bucket, missing, moving_avg, moving_percentiles, moving_fn, multi_terms, nested, normalize, parent, percentile_ranks, percentiles, percentiles_bucket, range, rare_terms, rate, reverse_nested, sampler, scripted_metric, serial_diff, significant_terms, significant_text, stats, stats_bucket, string_stats, sum, sum_bucket, terms, top_hits, t_test, top_metrics, value_count, weighted_avg, variable_width_histogram }>): 定义作为搜索请求的一部分运行的聚合。
- collapse (可选, { field, inner_hits, max_concurrent_group_searches, collapse }): 将搜索结果折叠为指定字段的值。
- explain (可选, 布尔值): 如果为 true，则作为命中的一部分返回有关分数计算的详细信息。
- ext (可选, 记录<字符串, 用户定义的值>): Elasticsearch 插件定义的搜索扩展的配置。
- from (可选, 数字): 开始文档偏移量。需要是非负数。默认情况下，您不能使用 from 和 size 参数对超过 10,000 个命中进行分页。要对更多命中进行分页，请使用 search_after 参数。
- highlight (可选, { encoder, fields }): 指定用于从搜索结果中的一个或多个字段中检索突出显示的代码段的突出显示器。
- track_total_hits (可选, 布尔值 | 数字): 准确计数与查询匹配的命中数。如果为 true，则以牺牲一些性能为代价返回确切的命中数。如果为 false，则响应不包括与查询匹配的总命中数。
- indices_boost (可选, 记录<字符串, 数字>[]): 提高指定索引中文档的 _score。
- docvalue_fields (可选, { field, format, include_unmapped }[]): 通配符 (*) 模式数组。请求返回响应的 hits.fields 属性中与这些模式匹配的字段名的文档值。
- knn (可选, { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits } | { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits }[]): 定义要运行的近似 kNN 搜索。
- rank (可选, { rrf }): 定义要使用的倒数排名融合 (RRF)。
- min_score (可选, 数字): 匹配文档的最低 _score。 _score 较低的文档不包含在搜索结果中。
- post_filter (可选, { 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }): 使用 post_filter 参数过滤搜索结果。搜索命中在计算聚合后进行过滤。后置过滤器对聚合结果没有影响。
- profile (可选, 布尔值): 设置为 true 以返回有关搜索请求中各个组件执行的详细计时信息。注意：这是一个调试工具，会增加搜索执行的开销。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })：使用查询 DSL 定义搜索定义。
- rescore (可选, { window_size, query, learning_to_rank } | { window_size, query, learning_to_rank }[]): 可用于通过仅对 query 和 post_filter 阶段返回的前几个（例如 100 - 500 个）文档重新排序来提高精度。
- retriever (可选, { standard, knn, rrf }): 检索器是一种规范，用于描述从搜索返回的顶部文档。检索器替换了搜索 API 中也返回顶部文档的其他元素，例如 query 和 knn。
- script_fields (可选, 记录<字符串, { script, ignore_failure }>): 检索每个命中的脚本评估（基于不同的字段）。
- search_after（可选，数字 | 数字 | 字符串 | 布尔值 | 空 | 用户定义值[]）：用于使用上一页中的一组排序值检索下一页匹配结果。
- size（可选，数字）：要返回的匹配结果数。默认情况下，您无法使用 from 和 size 参数对超过 10,000 个匹配结果进行分页。要对更多匹配结果进行分页，请使用 search_after 参数。
- slice（可选，{ field, id, max }）：可用于将滚动搜索拆分为多个切片，这些切片可以独立使用。
- sort（可选，字符串 | { _score, _doc, _geo_distance, _script } | 字符串 | { _score, _doc, _geo_distance, _script }[]）：<字段>:<方向> 对的列表。
- _source（可选，布尔值 | { excludes, includes }）：指示为匹配文档返回哪些源字段。这些字段在搜索响应的 hits._source 属性中返回。
- fields（可选，{ field, format, include_unmapped }[]）：通配符 (*) 模式的数组。请求在响应的 hits.fields 属性中返回与这些模式匹配的字段名称的值。
- suggest（可选，{ text }）：定义一个建议器，它根据提供的文本提供相似的术语。
- terminate_after（可选，数字）：为每个分片收集的最大文档数。如果查询达到此限制，Elasticsearch 将提前终止查询。Elasticsearch 在排序之前收集文档。请谨慎使用。Elasticsearch 将此参数应用于处理请求的每个分片。如果可能，请让 Elasticsearch 自动执行提前终止。避免为针对跨多个数据层的备份索引的数据流的请求指定此参数。如果设置为 0（默认值），则查询不会提前终止。
- timeout（可选，字符串）：指定等待每个分片响应的时间段。如果在超时到期之前没有收到响应，则请求失败并返回错误。默认为无超时。
- track_scores（可选，布尔值）：如果为 true，则计算并返回文档分数，即使分数不用于排序。
- version（可选，布尔值）：如果为 true，则返回文档版本作为匹配结果的一部分。
- seq_no_primary_term（可选，布尔值）：如果为 true，则返回每个匹配结果最后一次修改的序列号和主项。
- stored_fields（可选，字符串 | 字符串[]）：要作为匹配结果一部分返回的存储字段列表。如果未指定任何字段，则响应中不包含任何存储字段。如果指定了此字段，则 _source 参数默认为 false。您可以传递 _source: true 以在搜索响应中同时返回源字段和存储字段。
- pit（可选，{ id, keep_alive }）：将搜索限制在某个时间点 (PIT)。如果提供 PIT，则不能在请求路径中指定 <index>。
- runtime_mappings（可选，Record<string, { fetch_fields, format, input_field, target_field, target_index, script, type }>）：在搜索请求中定义一个或多个运行时字段。这些字段优先于具有相同名称的映射字段。
- stats（可选，字符串[]）：要与搜索关联的统计信息组。每个组都为其关联的搜索维护一个统计信息聚合。您可以使用索引统计信息 API 检索这些统计信息。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅指向缺少或关闭的索引，则请求将返回错误。即使请求指向其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则指向 foo*,bar* 的请求将返回错误。
- allow_partial_search_results（可选，布尔值）：如果为 true，则在出现分片请求超时或分片故障时返回部分结果。如果为 false，则返回没有部分结果的错误。
- analyzer（可选，字符串）：用于查询字符串的分析器。此参数只能在指定了 q 查询字符串参数时使用。
- analyze_wildcard（可选，布尔值）：如果为 true，则分析通配符和前缀查询。此参数只能在指定了 q 查询字符串参数时使用。
- batched_reduce_size（可选，数字）：应在协调节点上一次减少的分片结果数。如果请求中潜在的分片数量可能很大，则应使用此值作为一种保护机制，以减少每个搜索请求的内存开销。
- ccs_minimize_roundtrips（可选，布尔值）：如果为 true，则在执行跨集群搜索 (CCS) 请求时，协调节点和远程集群之间的网络往返次数将降至最低。
- default_operator（可选，枚举（"and" | "or"））：查询字符串查询的默认运算符：AND 或 OR。此参数只能在指定了 q 查询字符串参数时使用。
- df（可选，字符串）：在查询字符串中未给出字段前缀时用作默认值的字段。此参数只能在指定了 q 查询字符串参数时使用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）数组）：通配符模式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。
- ignore_throttled（可选，布尔值）：如果为 true，则在冻结时将忽略具体的、扩展的或别名的索引。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- lenient（可选，布尔值）：如果为 true，则将忽略查询字符串中基于格式的查询失败（例如，向数字字段提供文本）。此参数只能在指定了 q 查询字符串参数时使用。
- max_concurrent_shard_requests（可选，数字）：定义此搜索并发执行的每个节点的并发分片请求数。应使用此值来限制搜索对集群的影响，以便限制并发分片请求的数量。
- min_compatible_shard_node（可选，字符串）：可以处理请求的节点的最低版本。任何版本较低的处理节点都将无法处理该请求。
- preference（可选，字符串）：用于搜索的节点和分片。默认情况下，Elasticsearch 使用自适应副本选择从符合条件的节点和分片中进行选择，并考虑分配感知。有效值为：_only_local，仅在本地节点上的分片上运行搜索；_local，如果可能，在本地节点上的分片上运行搜索，否则，使用默认方法选择分片；_only_nodes:<节点 ID>,<节点 ID>，仅在指定的节点 ID 上运行搜索，其中，如果在多个选定节点上存在合适的碎片，则使用默认方法使用这些节点上的分片，或者，如果没有一个指定的节点可用，则使用默认方法从任何可用节点中选择分片；_prefer_nodes:<节点 ID>,<节点 ID>，如果可能，在指定的节点 ID 上运行搜索，否则，使用默认方法选择分片；_shards:<分片>,<分片>，仅在指定的分片上运行搜索；<自定义字符串>（任何不以 _ 开头的字符串），以使用相同的 <自定义字符串> 以相同的顺序将搜索路由到相同的分片。
- pre_filter_shard_size（可选，数字）：定义一个阈值，如果搜索请求扩展到的分片数量超过该阈值，则强制执行预过滤往返，以根据查询重写对搜索分片进行预过滤。例如，如果日期过滤器必须匹配，但分片边界和查询是不相交的，则此过滤器往返可以显着限制分片的数量（如果基于其重写方法，分片无法匹配任何文档）。如果未指定，则满足以下任一条件时，将执行预过滤阶段：请求的目标分片超过 128 个；请求的目标是一个或多个只读索引；查询的主排序目标是一个索引字段。
- request_cache（可选，布尔值）：如果为 true，则为 size 为 0 的请求启用搜索结果缓存。默认为索引级别设置。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- scroll（可选，字符串 | -1 | 0）：保留搜索上下文以进行滚动的期限。请参阅滚动搜索结果。默认情况下，此值不能超过 1d（24 小时）。您可以使用 search.max_keep_alive 集群级别设置来更改此限制。
- search_type（可选，枚举（"query_then_fetch" | "dfs_query_then_fetch"））：如何计算分布式词频以进行相关性评分。
- suggest_field（可选，字符串）：指定用于建议的字段。
- suggest_mode（可选，枚举（"missing" | "popular" | "always"））：指定建议模式。此参数只能在指定了 suggest_field 和 suggest_text 查询字符串参数时使用。
- suggest_size（可选，数字）：要返回的建议数量。此参数只能在指定了 suggest_field 和 suggest_text 查询字符串参数时使用。
- suggest_text（可选，字符串）：应为其返回建议的源文本。此参数只能在指定了 suggest_field 和 suggest_text 查询字符串参数时使用。
- typed_keys（可选，布尔值）：如果为 true，则聚合和建议器的名称将在响应中以其各自的类型作为前缀。
- rest_total_hits_as_int（可选，布尔值）：指示在 rest 搜索响应中 hits.total 应呈现为整数还是对象。
- _source_excludes（可选，字符串 | 字符串[]）：要从响应中排除的源字段列表。您还可以使用此参数从 _source_includes 查询参数中指定的子集中排除字段。如果 _source 参数为 false，则忽略此参数。
- _source_includes（可选，字符串 | 字符串数组）：要包含在响应中的源字段列表。如果指定了此参数，则仅返回这些源字段。您可以使用 _source_excludes 查询参数从此子集中排除字段。如果 _source 参数为 false，则此参数将被忽略。
- q（可选，字符串）：使用查询参数搜索的 Lucene 查询字符串语法中的查询。查询参数搜索不支持完整的 Elasticsearch 查询 DSL，但便于测试。
- force_synthetic_source（可选，布尔值）：此请求是否应强制使用合成 _source？使用此选项可测试映射是否支持合成 _source 并了解最坏情况下的性能。启用此选项后，获取的速度将比在索引中本地启用合成源的速度慢。

search_mvtedit

搜索矢量切片以查找地理空间值。以二进制 Mapbox 矢量切片的格式返回结果。

端点文档

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

参数edit

请求（对象）
- index（字符串 | 字符串数组）：要搜索的数据流、索引或别名列表
- field（字符串）：包含要返回的地理空间数据的字段
- zoom（数字）：要搜索的矢量切片的缩放级别
- x（数字）：要搜索的矢量切片的 X 坐标
- y（数字）：要搜索的矢量切片的 Y 坐标
- aggs（可选，记录<字符串，{ aggregations、meta、adjacency_matrix、auto_date_histogram、avg、avg_bucket、boxplot、bucket_script、bucket_selector、bucket_sort、bucket_count_ks_test、bucket_correlation、cardinality、categorize_text、children、composite、cumulative_cardinality、cumulative_sum、date_histogram、date_range、derivative、diversified_sampler、extended_stats、extended_stats_bucket、frequent_item_sets、filter、filters、geo_bounds、geo_centroid、geo_distance、geohash_grid、geo_line、geotile_grid、geohex_grid、global、histogram、ip_range、ip_prefix、inference、line、matrix_stats、max、max_bucket、median_absolute_deviation、min、min_bucket、missing、moving_avg、moving_percentiles、moving_fn、multi_terms、nested、normalize、parent、percentile_ranks、percentiles、percentiles_bucket、range、rare_terms、rate、reverse_nested、sampler、scripted_metric、serial_diff、significant_terms、significant_text、stats、stats_bucket、string_stats、sum、sum_bucket、terms、top_hits、t_test、top_metrics、value_count、weighted_avg、variable_width_histogram }>）：geotile_grid 的子聚合。

支持以下聚合类型：- avg - cardinality - max - min - sum buffer（可选，数字）：切片外部裁剪缓冲区的大小（以像素为单位）。这允许渲染器避免从超出切片范围的几何图形产生的轮廓伪影。 exact_bounds（可选，布尔值）：如果为 false，则元图层的要素是切片的边界框。如果为 true，则元图层的要素是由 geo_bounds 聚合产生的边界框。聚合在与 <zoom>/<x>/<y> 切片相交的 <field> 值上运行，wrap_longitude 设置为 false。结果边界框可能大于矢量切片。 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*，则每个要素都是单元格边界框的多边形。如果为 *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_query、script、script_score、shape、simple_query_string、span_containing、span_field_masking、span_first、span_multi、span_near、span_not、span_or、span_term、span_within、term、terms、terms_set、text_expansion、weighted_tokens、wildcard、wrapper、type }）：用于筛选搜索文档的查询 DSL。 runtime_mappings（可选，记录<字符串，{ 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 图层将包含额外的点要素，表示原始要素的建议标签位置。

search_shards编辑

返回有关将针对其执行搜索请求的索引和分片的信息。

端点文档

client.searchShards({ ... })

参数编辑

请求（对象）
- index（可选，字符串 | 字符串数组）：返回将针对其执行搜索请求的索引和分片。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅指向缺少或关闭的索引，则请求将返回错误。即使请求指向其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则指向 foo*,bar* 的请求将返回错误。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- local（可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。

search_template编辑

允许使用 Mustache 语言预渲染搜索定义。

端点文档

client.searchTemplate({ ... })

参数编辑

请求（对象）
- index（可选，字符串 | 字符串数组）：要搜索的数据流、索引和别名列表。支持通配符 (*)。
- explain（可选，布尔值）：如果为 true，则返回有关每个匹配项的分数计算的详细信息。
- id（可选，字符串）：要使用的搜索模板的 ID。如果未指定源，则此参数是必需的。
- params (可选, 记录<字符串, 用户定义的值>): 用于替换模板中 Mustache 变量的键值对。键是变量名。值是变量值。
- profile（可选，布尔值）：如果为 true，则对查询执行进行分析。
- source（可选，字符串）：内联搜索模板。支持与搜索 API 的请求正文相同的参数。还支持 Mustache 变量。如果未指定 ID，则此参数是必需的。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅指向缺少或关闭的索引，则请求将返回错误。即使请求指向其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则指向 foo*,bar* 的请求将返回错误。
- ccs_minimize_roundtrips（可选，boolean）：如果为 true，则针对跨集群搜索请求，将最小化网络往返次数。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_throttled（可选，布尔值）：如果为 true，则在限制时，指定的具体、扩展或别名索引不包括在响应中。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- scroll (可选, 字符串 | -1 | 0): 指定对滚动搜索维护索引一致视图的时间长度。
- search_type（可选，枚举（“query_then_fetch” | “dfs_query_then_fetch”））：搜索操作的类型。
- rest_total_hits_as_int（可选，布尔值）：如果为 true，则在响应中将 hits.total 呈现为整数。
- typed_keys（可选，boolean）：如果为 true，则响应将以聚合和建议器各自的类型作为前缀。

terms_enum编辑

术语枚举 API 可用于发现索引中以提供的字符串开头的术语。它专为自动完成场景中使用的低延迟查找而设计。

端点文档

client.termsEnum({ index, field })

参数编辑

请求（对象）
- index（字符串）：要搜索的数据流、索引和索引别名列表。支持通配符 (*) 表达式。
- field（字符串）：要在索引术语开头匹配的字符串。如果未提供，则考虑该字段中的所有术语。
- size（可选，数字）：要返回多少个匹配项。
- timeout（可选，字符串 | -1 | 0）：花费在收集结果上的最长时间。默认为“1s”（1 秒）。如果超过超时，则在响应中将 complete 标志设置为 false，并且结果可能部分或为空。
- case_insensitive（可选，布尔值）：如果为 true，则将提供的搜索字符串与索引术语匹配，而不区分大小写。
- index_filter（可选，{ 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_query、script、script_score、shape、simple_query_string、span_containing、span_field_masking、span_first、span_multi、span_near、span_not、span_or、span_term、span_within、term、terms、terms_set、text_expansion、weighted_tokens、wildcard、wrapper、type }）：如果提供的查询重写为 match_none，则允许过滤索引分片。
- string（可选，字符串）：应在其后返回索引中术语的字符串。如果将一个请求的最后一个结果作为后续请求的 search_after 参数传递，则允许进行一种分页形式。
- search_after（可选，字符串）

termvectors编辑

返回有关特定文档字段中术语的信息和统计信息。

端点文档

client.termvectors({ index })

参数编辑

请求（对象）
- index（字符串）：包含文档的索引的名称。
- id（可选，字符串）：文档的唯一标识符。
- doc（可选，对象）：要为其检索术语向量的虚拟文档（索引中不存在的文档）。
- filter（可选，{ max_doc_freq、max_num_terms、max_term_freq、max_word_length、min_doc_freq、min_term_freq、min_word_length }）：根据其 tf-idf 分数过滤术语。
- per_field_analyzer（可选，记录<字符串，字符串>）：覆盖默认的每字段分析器。
- fields（可选，string | string[]）：要包含在统计信息中的字段的列表或通配符表达式。用作默认列表，除非在 completion_fields 或 fielddata_fields 参数中提供了特定的字段列表。
- field_statistics（可选，boolean）：如果为 true，则响应将包括文档计数、文档频率总和和词条频率总和。
- offsets（可选，boolean）：如果为 true，则响应将包括词条偏移量。
- payloads（可选，boolean）：如果为 true，则响应将包括词条有效负载。
- positions（可选，boolean）：如果为 true，则响应将包括词条位置。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- realtime （可选，布尔值）：如果为 true，则请求是实时的，而不是近实时的。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- term_statistics（可选，布尔值）：如果为 true，则响应包括词频和文档频率。
- version（可选，number）：如果为 true，则返回文档版本作为匹配的一部分。
- version_type（可选，Enum("internal" | "external" | "external_gte" | "force"))：特定版本类型。

update编辑

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

端点文档

client.update({ id, index })

参数编辑

请求（对象）
- id（字符串）：文档 ID
- index（字符串）：索引的名称
- detect_noop （可选，布尔值）：设置为 false 以禁用在未发生文档更改时将响应中的 result 设置为 noop。
- doc （可选，对象）：现有文档的部分更新。
- doc_as_upsert （可选，布尔值）：设置为 true 以使用 doc 的内容作为 upsert 的值
- script （可选，{ lang, options, source } | { id }）：要执行以更新文档的脚本。
- scripted_upsert （可选，布尔值）：设置为 true 以执行脚本，无论文档是否存在。
- _source （可选，布尔值 | { excludes, includes }）：设置为 false 以禁用源检索。您还可以指定要检索的字段的逗号分隔列表。
- upsert （可选，对象）：如果文档不存在，则将 upsert 的内容作为新文档插入。如果文档存在，则执行 script。
- if_primary_term （可选，数字）：仅当文档具有此主期限时才执行操作。
- if_seq_no （可选，数字）：仅当文档具有此序列号时才执行操作。
- lang （可选，字符串）：脚本语言。
- refresh （可选，枚举（true | false | "wait_for"））：如果为 true，Elasticsearch 会刷新受影响的分片以使此操作对搜索可见；如果为 wait_for，则等待刷新以使此操作对搜索可见；如果为 false，则不对刷新执行任何操作。
- require_alias （可选，布尔值）：如果为 true，则目标必须是索引别名。
- retry_on_conflict （可选，数字）：指定发生冲突时应重试操作的次数。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- timeout （可选，字符串 | -1 | 0）：等待动态映射更新和活动分片的周期。这保证 Elasticsearch 在失败之前至少等待超时时间。实际等待时间可能会更长，尤其是在发生多次等待时。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数（number_of_replicas+1）。默认为 1，表示主分片。
- _source_excludes （可选，字符串 | 字符串[]）：指定要排除的源字段。
- _source_includes （可选，字符串 | 字符串[]）：指定要检索的源字段。

update_by_query编辑

对索引中的每个文档执行更新，而不更改源，例如，获取映射更改。

端点文档

client.updateByQuery({ index })

参数编辑

请求（对象）
- index （字符串 | 字符串数组）：要搜索的数据流、索引和别名列表。支持通配符 (*)。要搜索所有数据流或索引，请省略此参数或使用 * 或 _all。
- max_docs （可选，数字）：要更新的最大文档数。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：使用查询 DSL 指定要更新的文档。
- script （可选，{ lang, options, source } | { id }）：更新时运行以更新文档源或元数据的脚本。
- slice （可选，{ field, id, max }）：使用提供的切片 ID 和切片总数手动切片请求。
- conflicts （可选，枚举（"abort" | "proceed"））：如果按查询更新遇到版本冲突，该怎么办：abort 或 proceed。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅指向缺少或关闭的索引，则请求将返回错误。即使请求指向其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则指向 foo*,bar* 的请求将返回错误。
- analyzer （可选，字符串）：用于查询字符串的分析器。
- analyze_wildcard （可选，布尔值）：如果为 true，则分析通配符和前缀查询。
- default_operator （可选，枚举（"and" | "or"））：查询字符串查询的默认运算符：AND 或 OR。
- df （可选，字符串）：在查询字符串中未给出字段前缀时用作默认值的字段。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- from （可选，数字）：起始偏移量（默认值：0）
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- lenient （可选，布尔值）：如果为 true，则将忽略查询字符串中基于格式的查询失败（例如，向数字字段提供文本）。
- pipeline （可选，字符串）：用于预处理传入文档的管道 ID。如果索引指定了默认摄取管道，则将该值设置为 _none 会禁用此请求的默认摄取管道。如果配置了最终管道，则无论此参数的值如何，它都将始终运行。
- preference （可选，字符串）：指定应在其上执行操作的节点或分片。默认为随机。
- refresh （可选，布尔值）：如果为 true，Elasticsearch 会刷新受影响的分片以使操作对搜索可见。
- request_cache （可选，布尔值）：如果为 true，则对此请求使用请求缓存。
- requests_per_second （可选，浮点数）：此请求在每秒子请求中的限制。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- scroll （可选，字符串 | -1 | 0）：保留滚动搜索上下文的期限。
- scroll_size （可选，数字）：为操作提供支持的滚动请求的大小。
- search_timeout （可选，字符串 | -1 | 0）：每个搜索请求的显式超时。
- search_type （可选，枚举（"query_then_fetch" | "dfs_query_then_fetch"））：搜索操作的类型。可用选项：query_then_fetch、dfs_query_then_fetch。
- slices （可选，数字 | 枚举（"auto"））：此任务应划分成的切片数。
- sort （可选，字符串[]）：<字段>:<方向> 对的列表。
- stats （可选，字符串[]）：用于日志记录和统计目的的请求的特定 tag。
- terminate_after （可选，数字）：要为每个分片收集的最大文档数。如果查询达到此限制，Elasticsearch 会提前终止查询。Elasticsearch 在排序之前收集文档。请谨慎使用。Elasticsearch 将此参数应用于处理请求的每个分片。如果可能，让 Elasticsearch 自动执行提前终止。避免为针对跨多个数据层的备份索引上的数据流的请求指定此参数。
- timeout （可选，字符串 | -1 | 0）：每个更新请求等待以下操作的周期：动态映射更新、等待活动分片。
- version （可选，布尔值）：如果为 true，则返回文档版本作为匹配结果的一部分。
- version_type （可选，布尔值）：文档是否应在命中时增加版本号（内部）或不增加版本号（重新索引）
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。
- wait_for_completion （可选，布尔值）：如果为 true，则请求将阻塞，直到操作完成。

update_by_query_rethrottle编辑

更改特定“按查询更新”操作的每秒请求数。

端点文档

client.updateByQueryRethrottle({ task_id })

参数编辑

请求（对象）
- task_id （字符串）：任务的 ID。
- requests_per_second （可选，浮点数）：此请求在每秒子请求中的限制。

async_search编辑

delete编辑

按 ID 删除异步搜索。如果搜索仍在运行，则搜索请求将被取消。否则，将删除保存的搜索结果。

端点文档

client.asyncSearch.delete({ id })

参数编辑

请求（对象）
- id （字符串）：异步搜索的唯一标识符。

get编辑

检索先前提交的异步搜索请求的结果（如果给定其 ID）。

端点文档

client.asyncSearch.get({ id })

参数编辑

请求（对象）
- id （字符串）：异步搜索的唯一标识符。
- keep_alive （可选，字符串 | -1 | 0）：指定异步搜索在集群中应可用的时间。如果未指定，则将使用与相应提交的异步请求一起设置的 keep_alive。否则，可以覆盖该值并延长请求的有效期。当此期限到期时，如果搜索仍在运行，则会被取消。如果搜索已完成，则会删除其保存的结果。
- typed_keys （可选，布尔值）：指定在响应中是否应在其相应类型的聚合器和建议器名称前添加前缀
- wait_for_completion_timeout （可选，字符串 | -1 | 0）：指定等待搜索完成，直到达到提供的超时时间。如果在超时到期之前有最终结果，则返回最终结果；否则，一旦超时到期，则返回当前可用的结果。默认情况下，不设置超时，这意味着将返回当前可用的结果，而无需任何额外等待。

status编辑

检索先前提交的异步搜索请求的状态（如果给定其 ID）。

端点文档

client.asyncSearch.status({ id })

参数编辑

请求（对象）
- id （字符串）：异步搜索的唯一标识符。

submit编辑

异步执行搜索请求。

端点文档

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

参数编辑

请求（对象）
- index （可选，字符串 | 字符串[]）：要搜索的索引名称列表；使用 _all 或空字符串对所有索引执行操作
- aggregations （可选，记录<字符串，{ aggregations, meta, adjacency_matrix, auto_date_histogram, avg, avg_bucket, boxplot, bucket_script, bucket_selector, bucket_sort, bucket_count_ks_test, bucket_correlation, cardinality, categorize_text, children, composite, cumulative_cardinality, cumulative_sum, date_histogram, date_range, derivative, diversified_sampler, extended_stats, extended_stats_bucket, frequent_item_sets, filter, filters, geo_bounds, geo_centroid, geo_distance, geohash_grid, geo_line, geotile_grid, geohex_grid, global, histogram, ip_range, ip_prefix, inference, line, matrix_stats, max, max_bucket, median_absolute_deviation, min, min_bucket, missing, moving_avg, moving_percentiles, moving_fn, multi_terms, nested, normalize, parent, percentile_ranks, percentiles, percentiles_bucket, range, rare_terms, rate, reverse_nested, sampler, scripted_metric, serial_diff, significant_terms, significant_text, stats, stats_bucket, string_stats, sum, sum_bucket, terms, top_hits, t_test, top_metrics, value_count, weighted_avg, variable_width_histogram }>）
- collapse （可选，{ field, inner_hits, max_concurrent_group_searches, collapse }）
- explain (可选, 布尔值): 如果为 true，则作为命中的一部分返回有关分数计算的详细信息。
- ext (可选, 记录<字符串, 用户定义的值>): Elasticsearch 插件定义的搜索扩展的配置。
- from （可选，数字）：开始文档偏移量。默认情况下，您不能使用 from 和 size 参数对超过 10,000 个匹配结果进行分页。要对更多匹配结果进行分页，请使用 search_after 参数。
- highlight （可选，{ encoder, fields }）
- track_total_hits （可选，布尔值 | 数字）：要准确计数的与查询匹配的匹配结果数。如果为 true，则返回确切的匹配结果数，但会降低一些性能。如果为 false，则响应不包括与查询匹配的匹配结果总数。默认为 10,000 个匹配结果。
- indices_boost (可选, 记录<字符串, 数字>[]): 提高指定索引中文档的 _score。
- docvalue_fields （可选，{ field, format, include_unmapped }[]）：通配符 (*) 模式数组。请求返回与响应的 hits.fields 属性中的这些模式匹配的字段名称的文档值。
- knn (可选, { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits } | { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits }[]): 定义要运行的近似 kNN 搜索。
- min_score （可选，数字）：匹配文档的最低 _score。 _score 低于此值的文档不包含在搜索结果中。
- post_filter （可选，{ 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）
- profile （可选，布尔值）
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })：使用查询 DSL 定义搜索定义。
- rescore （可选，{ window_size, query, learning_to_rank } | { window_size, query, learning_to_rank }[]）
- script_fields (可选, 记录<字符串, { script, ignore_failure }>): 检索每个命中的脚本评估（基于不同的字段）。
- search_after （可选，数字 | 数字 | 字符串 | 布尔值 | null | 用户自定义值[]）
- size （可选，数字）：要返回的匹配数量。默认情况下，使用 from 和 size 参数不能对超过 10,000 个匹配进行分页。要对更多匹配进行分页，请使用 search_after 参数。
- slice （可选，{ field, id, max }）
- sort （可选，字符串 | { _score, _doc, _geo_distance, _script } | 字符串 | { _score, _doc, _geo_distance, _script }[]）
- _source（可选，布尔值 | { excludes, includes }）：指示为匹配文档返回哪些源字段。这些字段在搜索响应的 hits._source 属性中返回。
- fields （可选，{ field, format, include_unmapped }[]）：通配符 (*) 模式数组。请求返回响应的 hits.fields 属性中与这些模式匹配的字段名称的值。
- suggest （可选，{ text }）
- terminate_after （可选，数字）：为每个分片收集的最大文档数。如果查询达到此限制，Elasticsearch 会提前终止查询。Elasticsearch 在排序之前收集文档。默认为 0，不会提前终止查询执行。
- timeout（可选，字符串）：指定等待每个分片响应的时间段。如果在超时到期之前没有收到响应，则请求失败并返回错误。默认为无超时。
- track_scores（可选，布尔值）：如果为 true，则计算并返回文档分数，即使分数不用于排序。
- version（可选，布尔值）：如果为 true，则返回文档版本作为匹配结果的一部分。
- seq_no_primary_term （可选，布尔值）：如果为 true，则返回每次匹配的最后一次修改的序列号和主项。请参阅乐观并发控制。
- stored_fields（可选，字符串 | 字符串数组）：要作为命中的一部分返回的存储字段列表。如果未指定任何字段，则响应中不包含任何存储字段。如果指定了此字段，则 _source 参数默认为 false。您可以传递 _source: true 以在搜索响应中同时返回源字段和存储字段。
- pit （可选，{ id, keep_alive }）：将搜索限制在某个时间点 (PIT)。如果提供 PIT，则无法在请求路径中指定 <index>。
- runtime_mappings（可选，Record<string, { fetch_fields, format, input_field, target_field, target_index, script, type }>）：在搜索请求中定义一个或多个运行时字段。这些字段优先于具有相同名称的映射字段。
- stats（可选，字符串[]）：要与搜索关联的统计信息组。每个组都为其关联的搜索维护一个统计信息聚合。您可以使用索引统计信息 API 检索这些统计信息。
- wait_for_completion_timeout （可选，字符串 | -1 | 0）：阻塞并等待搜索完成，直至达到特定超时。当异步搜索在超时时间内完成时，响应将不包含 ID，因为结果未存储在集群中。
- keep_on_completion （可选，布尔值）：如果为 true，则在搜索在 wait_for_completion_timeout 内完成时存储结果以供稍后检索。
- keep_alive （可选，字符串 | -1 | 0）：指定异步搜索需要可用多长时间。在此期限后，将删除正在进行的异步搜索和任何已保存的搜索结果。
- allow_no_indices （可选，布尔值）：是否忽略通配符索引表达式解析为无具体索引的情况。（这包括 _all 字符串或未指定任何索引时）
- allow_partial_search_results （可选，布尔值）：指示如果出现部分搜索失败或超时，是否应返回错误
- analyzer （可选，字符串）：用于查询字符串的分析器
- analyze_wildcard （可选，布尔值）：指定是否应分析通配符和前缀查询（默认值：false）
- batched_reduce_size （可选，数字）：影响部分结果可用的频率，每当分片结果减少时就会发生这种情况。每次协调节点收到一定数量的新分片响应（默认为 5）时，都会执行部分缩减。
- ccs_minimize_roundtrips （可选，布尔值）：默认值是唯一受支持的值。
- default_operator （可选，枚举（"and" | "or"））：查询字符串查询的默认运算符（AND 或 OR）
- df （可选，字符串）：在查询字符串中未给出字段前缀时用作默认值的字段
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：是否将通配符表达式扩展到打开、关闭或同时打开和关闭的具体索引。
- ignore_throttled （可选，布尔值）：在限制时是否应忽略指定的具体索引、扩展索引或别名索引
- ignore_unavailable （可选，布尔值）：当指定的具体索引不可用（丢失或关闭）时是否应忽略它们
- lenient （可选，布尔值）：指定是否应忽略基于格式的查询失败（例如，向数字字段提供文本）
- max_concurrent_shard_requests （可选，数字）：此搜索并发执行的每个节点的并发分片请求数。应使用此值来限制搜索对集群的影响，以限制并发分片请求的数量
- min_compatible_shard_node （可选，字符串）
- preference （可选，字符串）：指定应在其上执行操作的节点或分片（默认值：随机）
- pre_filter_shard_size （可选，数字）：默认值无法更改，这会强制执行预过滤往返以从每个分片检索统计信息，以便跳过肯定不包含与查询匹配的任何文档的分片。
- request_cache （可选，布尔值）：指定是否应为此请求使用请求缓存，默认为 true
- routing（可选，字符串）：特定路由值列表
- scroll （可选，字符串 | -1 | 0）
- search_type （可选，枚举（"query_then_fetch" | "dfs_query_then_fetch"））：搜索操作类型
- suggest_field（可选，字符串）：指定用于建议的字段。
- suggest_mode （可选，枚举（"missing" | "popular" | "always"））：指定建议模式
- suggest_size （可选，数字）：要在响应中返回的建议数量
- suggest_text （可选，字符串）：应为其返回建议的源文本。
- typed_keys （可选，布尔值）：指定在响应中是否应在其相应类型的聚合器和建议器名称前添加前缀
- rest_total_hits_as_int （可选，布尔值）
- _source_excludes （可选，字符串 | 字符串[]）：要从返回的 _source 字段中排除的字段列表
- _source_includes （可选，字符串 | 字符串[]）：要从 _source 字段中提取并返回的字段列表
- q （可选，字符串）：使用 Lucene 查询字符串语法的查询

自动扩缩编辑

删除自动扩缩策略编辑

删除自动扩缩策略。专为 ECE/ESS 和 ECK 间接使用而设计。不支持直接使用。

端点文档

client.autoscaling.deleteAutoscalingPolicy({ name })

参数编辑

请求（对象）
- name （字符串）：自动扩缩策略的名称

获取自动扩缩容量编辑

根据配置的自动扩缩策略获取当前的自动扩缩容量。专为 ECE/ESS 和 ECK 间接使用而设计。不支持直接使用。

端点文档

client.autoscaling.getAutoscalingCapacity()

获取自动扩缩策略编辑

检索自动扩缩策略。专为 ECE/ESS 和 ECK 间接使用而设计。不支持直接使用。

端点文档

client.autoscaling.getAutoscalingPolicy({ name })

参数编辑

请求（对象）
- name （字符串）：自动扩缩策略的名称

放置自动扩缩策略编辑

创建新的自动扩缩策略。专为 ECE/ESS 和 ECK 间接使用而设计。不支持直接使用。

端点文档

client.autoscaling.putAutoscalingPolicy({ name })

参数编辑

请求（对象）
- name （字符串）：自动扩缩策略的名称
- policy （可选，{ roles, deciders }）

cat编辑

别名编辑

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

端点文档

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

参数编辑

请求（对象）
- name （可选，字符串 | 字符串[]）：要检索的别名列表。支持通配符 (*)。要检索所有别名，请省略此参数或使用 * 或 _all。
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：是否将通配符表达式扩展到打开、关闭或同时打开和关闭的具体索引。

分配编辑

提供为每个数据节点分配了多少分片以及它们正在使用多少磁盘空间的快照。

端点文档

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

参数编辑

请求（对象）
- node_id （可选，字符串 | 字符串[]）：用于限制返回信息的节点标识符或名称列表。
- bytes （可选，枚举（"b" | "kb" | "mb" | "gb" | "tb" | "pb"））：用于显示字节值的单位。

组件模板编辑

返回有关现有 component_templates 模板的信息。

端点文档

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

参数编辑

请求（对象）
- name （可选，字符串）：组件模板的名称。接受通配符表达式。如果省略，则返回所有组件模板。

计数编辑

提供对整个集群或单个索引的文档计数的快速访问。

端点文档

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

参数编辑

请求（对象）
- index（可选，string | string[]）：用于限制请求的数据流、索引和别名列表。支持通配符（*）。要定位所有数据流和索引，请省略此参数或使用*或_all。

fielddata编辑

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

端点文档

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

参数编辑

请求（对象）
- fields（可选，string | string[]）：用于限制返回信息的字段列表。要检索所有字段，请省略此参数。
- bytes （可选，枚举（"b" | "kb" | "mb" | "gb" | "tb" | "pb"））：用于显示字节值的单位。

health编辑

返回集群运行状况的简明表示。

端点文档

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

参数编辑

请求（对象）
- time（可选，枚举（"nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"））：用于显示时间值的单位。
- ts（可选，布尔值）：如果为 true，则返回 HH:MM:SS 和 Unix 时间戳。

help编辑

返回 Cat API 的帮助。

端点文档

client.cat.help()

indices编辑

返回有关索引的信息：主副本和副本数、文档计数、磁盘大小等。

端点文档

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

参数编辑

请求（对象）
- index（可选，string | string[]）：用于限制请求的数据流、索引和别名列表。支持通配符（*）。要定位所有数据流和索引，请省略此参数或使用*或_all。
- bytes （可选，枚举（"b" | "kb" | "mb" | "gb" | "tb" | "pb"））：用于显示字节值的单位。
- expand_wildcards（可选，枚举（"all" | "open" | "closed" | "hidden" | "none"）| 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。
- health（可选，枚举（"green" | "yellow" | "red"））：用于限制返回索引的运行状况状态。默认情况下，响应包括任何运行状况状态的索引。
- include_unloaded_segments（可选，布尔值）：如果为 true，则响应包括未加载到内存中的段的信息。
- pri（可选，布尔值）：如果为 true，则响应仅包括来自主分片的信息。
- time（可选，枚举（"nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"））：用于显示时间值的单位。

master编辑

返回有关主节点的信息。

端点文档

client.cat.master()

ml_data_frame_analytics编辑

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

端点文档

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

参数编辑

请求（对象）
- id（可选，字符串）：要获取的数据帧分析的 ID
- allow_no_match（可选，布尔值）：如果通配符表达式不匹配任何配置，是否忽略。（这包括 _all 字符串或未指定任何配置时）
- bytes（可选，枚举（"b" | "kb" | "mb" | "gb" | "tb" | "pb"））：用于显示字节值的单位
- h（可选，枚举（"assignment_explanation" | "create_time" | "description" | "dest_index" | "failure_reason" | "id" | "model_memory_limit" | "node.address" | "node.ephemeral_id" | "node.id" | "node.name" | "progress" | "source_index" | "state" | "type" | "version"）| 枚举（"assignment_explanation" | "create_time" | "description" | "dest_index" | "failure_reason" | "id" | "model_memory_limit" | "node.address" | "node.ephemeral_id" | "node.id" | "node.name" | "progress" | "source_index" | "state" | "type" | "version"）[]）：要显示的列名列表。
- s（可选，枚举（"assignment_explanation" | "create_time" | "description" | "dest_index" | "failure_reason" | "id" | "model_memory_limit" | "node.address" | "node.ephemeral_id" | "node.id" | "node.name" | "progress" | "source_index" | "state" | "type" | "version"）| 枚举（"assignment_explanation" | "create_time" | "description" | "dest_index" | "failure_reason" | "id" | "model_memory_limit" | "node.address" | "node.ephemeral_id" | "node.id" | "node.name" | "progress" | "source_index" | "state" | "type" | "version"）[]）：用于对响应进行排序的列名或列别名列表。
- time（可选，字符串 | -1 | 0）：用于显示时间值的单位。

ml_datafeeds编辑

获取有关数据馈送的配置和使用情况信息。

端点文档

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

参数编辑

请求（对象）
- datafeed_id（可选，字符串）：唯一标识数据馈送的数字字符串。
- allow_no_match（可选，布尔值）：指定当请求
包含通配符表达式并且没有匹配的数据馈送时该怎么办。
包含 _all 字符串或没有标识符并且没有匹配项时该怎么办。
包含通配符表达式并且只有部分匹配时该怎么办。

如果为 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"））：用于显示时间值的单位。

ml_jobs编辑

获取有关异常检测作业的配置和使用情况信息。

端点文档

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

参数编辑

请求（对象）
- job_id（可选，字符串）：异常检测作业的标识符。
- allow_no_match（可选，布尔值）：指定当请求
包含通配符表达式并且没有匹配的作业。
包含 _all 字符串或没有标识符并且没有匹配项时该怎么办。
包含通配符表达式并且只有部分匹配时该怎么办。

ml_trained_models编辑

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

端点文档

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

参数编辑

请求（对象）
- model_id（可选，字符串）：训练模型的唯一标识符。
- allow_no_match（可选，布尔值）：指定当请求满足以下条件时要执行的操作：包含通配符表达式并且没有匹配的模型；包含 _all 字符串或没有标识符并且没有匹配项；包含通配符表达式并且只有部分匹配项。如果为 true，则当没有匹配项时，API 将返回一个空数组；当存在部分匹配项时，则返回结果子集。如果为 false，则当没有匹配项或只有部分匹配项时，API 将返回 404 状态代码。
- bytes （可选，枚举（"b" | "kb" | "mb" | "gb" | "tb" | "pb"））：用于显示字节值的单位。
- h（可选，枚举（“create_time” | “created_by” | “data_frame_analytics_id” | “description” | “heap_size” | “id” | “ingest.count” | “ingest.current” | “ingest.failed” | “ingest.pipelines” | “ingest.time” | “license” | “operations” | “version”） | 枚举（“create_time” | “created_by” | “data_frame_analytics_id” | “description” | “heap_size” | “id” | “ingest.count” | “ingest.current” | “ingest.failed” | “ingest.pipelines” | “ingest.time” | “license” | “operations” | “version”）[]）：要显示的列名列表。
- s（可选，枚举（“create_time” | “created_by” | “data_frame_analytics_id” | “description” | “heap_size” | “id” | “ingest.count” | “ingest.current” | “ingest.failed” | “ingest.pipelines” | “ingest.time” | “license” | “operations” | “version”） | 枚举（“create_time” | “created_by” | “data_frame_analytics_id” | “description” | “heap_size” | “id” | “ingest.count” | “ingest.current” | “ingest.failed” | “ingest.pipelines” | “ingest.time” | “license” | “operations” | “version”）[]）：用于对响应进行排序的列名或别名列表。
- from（可选，数字）：跳过指定数量的转换。
- size（可选，数字）：要显示的最大转换数量。

nodeattrs编辑

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

端点文档

client.cat.nodeattrs()

nodes编辑

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

端点文档

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

参数编辑

请求（对象）
- bytes （可选，枚举（"b" | "kb" | "mb" | "gb" | "tb" | "pb"））：用于显示字节值的单位。
- full_id（可选，布尔值 | 字符串）：如果为 true，则返回完整的节点 ID。如果为 false，则返回缩短的节点 ID。
- include_unloaded_segments（可选，布尔值）：如果为 true，则响应包括未加载到内存中的段的信息。

pending_tasks编辑

返回集群待处理任务的简要表示。

端点文档

client.cat.pendingTasks()

plugins编辑

返回有关节点上安装的插件的信息。

端点文档

client.cat.plugins()

recovery编辑

返回有关索引分片恢复的信息，包括正在进行和已完成的恢复。

端点文档

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

参数编辑

请求（对象）
- index（可选，字符串 | 字符串[]）：用于限制请求的数据流、索引和别名列表。支持通配符 (*)。要定位所有数据流和索引，请省略此参数或使用 * 或 _all。
- active_only（可选，布尔值）：如果为 true，则响应仅包含正在进行的分片恢复。
- bytes （可选，枚举（"b" | "kb" | "mb" | "gb" | "tb" | "pb"））：用于显示字节值的单位。
- detailed（可选，布尔值）：如果为 true，则响应包含有关分片恢复的详细信息。

repositories编辑

返回有关集群中注册的快照存储库的信息。

端点文档

client.cat.repositories()

segments编辑

提供有关索引分片中段的低级信息。

端点文档

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

参数编辑

请求（对象）
- index（可选，字符串 | 字符串[]）：用于限制请求的数据流、索引和别名列表。支持通配符 (*)。要定位所有数据流和索引，请省略此参数或使用 * 或 _all。
- bytes （可选，枚举（"b" | "kb" | "mb" | "gb" | "tb" | "pb"））：用于显示字节值的单位。

shards编辑

提供节点上分片分配的详细视图。

端点文档

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

参数编辑

请求（对象）
- index（可选，字符串 | 字符串[]）：用于限制请求的数据流、索引和别名列表。支持通配符 (*)。要定位所有数据流和索引，请省略此参数或使用 * 或 _all。
- bytes （可选，枚举（"b" | "kb" | "mb" | "gb" | "tb" | "pb"））：用于显示字节值的单位。

snapshots编辑

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

端点文档

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

参数编辑

请求（对象）
- repository（可选，字符串 | 字符串[]）：用于限制请求的快照存储库列表。接受通配符表达式。 _all 返回所有存储库。如果在请求期间任何存储库失败，Elasticsearch 将返回错误。
- ignore_unavailable（可选，布尔值）：如果为 true，则响应不包含来自不可用快照的信息。

tasks编辑

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

端点文档

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

参数编辑

请求（对象）
- actions（可选，字符串数组）：任务操作名称，用于限制响应。
- detailed（可选，布尔值）：如果为 true，则响应包含有关分片恢复的详细信息。
- node_id（可选，字符串数组）：唯一节点标识符，用于限制响应。
- parent_task_id（可选，字符串）：父任务标识符，用于限制响应。

模板编辑

返回有关现有模板的信息。

端点文档

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

参数编辑

请求（对象）
- name（可选，字符串）：要返回的模板的名称。接受通配符表达式。如果省略，则返回所有模板。

线程池编辑

返回每个节点的集群范围线程池统计信息。默认情况下，将返回所有线程池的活动、队列和拒绝统计信息。

端点文档

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

参数编辑

请求（对象）
- thread_pool_patterns（可选，字符串 | 字符串数组）：用于限制请求的线程池名称列表。接受通配符表达式。
- time（可选，枚举（"nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"））：用于显示时间值的单位。

转换编辑

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

端点文档

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

参数编辑

请求（对象）
- transform_id（可选，字符串）：转换标识符或通配符表达式。如果您未指定这些选项中的任何一个，则 API 将返回所有转换的信息。
- allow_no_match（可选，布尔值）：指定当请求满足以下条件时要执行的操作：包含通配符表达式并且没有匹配的转换；包含 _all 字符串或没有标识符并且没有匹配项；包含通配符表达式并且只有部分匹配项。如果为 true，则在没有匹配项时返回空转换数组，在部分匹配时返回结果子集。如果为 false，则当没有匹配项或只有部分匹配项时，请求返回 404 状态代码。
- from（可选，数字）：跳过指定数量的转换。
- h（可选，枚举（"changes_last_detection_time" | "checkpoint" | "checkpoint_duration_time_exp_avg" | "checkpoint_progress" | "create_time" | "delete_time" | "description" | "dest_index" | "documents_deleted" | "documents_indexed" | "docs_per_second" | "documents_processed" | "frequency" | "id" | "index_failure" | "index_time" | "index_total" | "indexed_documents_exp_avg" | "last_search_time" | "max_page_search_size" | "pages_processed" | "pipeline" | "processed_documents_exp_avg" | "processing_time" | "reason" | "search_failure" | "search_time" | "search_total" | "source_index" | "state" | "transform_type" | "trigger_count" | "version") | 枚举（"changes_last_detection_time" | "checkpoint" | "checkpoint_duration_time_exp_avg" | "checkpoint_progress" | "create_time" | "delete_time" | "description" | "dest_index" | "documents_deleted" | "documents_indexed" | "docs_per_second" | "documents_processed" | "frequency" | "id" | "index_failure" | "index_time" | "index_total" | "indexed_documents_exp_avg" | "last_search_time" | "max_page_search_size" | "pages_processed" | "pipeline" | "processed_documents_exp_avg" | "processing_time" | "reason" | "search_failure" | "search_time" | "search_total" | "source_index" | "state" | "transform_type" | "trigger_count" | "version")[]）：要显示的列名列表。
- s（可选，枚举（"changes_last_detection_time" | "checkpoint" | "checkpoint_duration_time_exp_avg" | "checkpoint_progress" | "create_time" | "delete_time" | "description" | "dest_index" | "documents_deleted" | "documents_indexed" | "docs_per_second" | "documents_processed" | "frequency" | "id" | "index_failure" | "index_time" | "index_total" | "indexed_documents_exp_avg" | "last_search_time" | "max_page_search_size" | "pages_processed" | "pipeline" | "processed_documents_exp_avg" | "processing_time" | "reason" | "search_failure" | "search_time" | "search_total" | "source_index" | "state" | "transform_type" | "trigger_count" | "version") | 枚举（"changes_last_detection_time" | "checkpoint" | "checkpoint_duration_time_exp_avg" | "checkpoint_progress" | "create_time" | "delete_time" | "description" | "dest_index" | "documents_deleted" | "documents_indexed" | "docs_per_second" | "documents_processed" | "frequency" | "id" | "index_failure" | "index_time" | "index_total" | "indexed_documents_exp_avg" | "last_search_time" | "max_page_search_size" | "pages_processed" | "pipeline" | "processed_documents_exp_avg" | "processing_time" | "reason" | "search_failure" | "search_time" | "search_total" | "source_index" | "state" | "transform_type" | "trigger_count" | "version")[]）：用于对响应进行排序的列名或列别名列表。
- time（可选，枚举（"nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"））：用于显示时间值的单位。
- size（可选，数字）：要获取的最大转换数。

跨集群复制编辑

删除自动跟随模式编辑

删除自动跟随模式。

端点文档

client.ccr.deleteAutoFollowPattern({ name })

参数编辑

请求（对象）
- name（字符串）：自动跟随模式的名称。

跟随编辑

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

端点文档

client.ccr.follow({ index })

参数编辑

请求（对象）
- index（字符串）：跟随索引的名称
- leader_index（可选，字符串）
- max_outstanding_read_requests（可选，数字）
- max_outstanding_write_requests（可选，数字）
- max_read_request_operation_count（可选，数字）
- max_read_request_size（可选，字符串）
- max_retry_delay（可选，字符串 | -1 | 0）
- max_write_buffer_count（可选，数字）
- max_write_buffer_size（可选，字符串）
- max_write_request_operation_count（可选，数字）
- max_write_request_size（可选，字符串）
- read_poll_timeout（可选，字符串 | -1 | 0）
- remote_cluster（可选，字符串）
- wait_for_active_shards（可选，数字 | 枚举（"all" | "index-setting"））：设置在返回之前必须处于活动状态的分片副本数。默认为 0。设置为 all 表示所有分片副本，否则设置为小于或等于分片副本总数（副本数 + 1）的任何非负值

跟随信息编辑

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

端点文档

client.ccr.followInfo({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串数组）：索引模式列表；使用 _all 对所有索引执行操作

跟随统计信息编辑

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

端点文档

client.ccr.followStats({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串数组）：索引模式列表；使用 _all 对所有索引执行操作

忘记跟随者编辑

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

端点文档

client.ccr.forgetFollower({ index })

参数编辑

请求（对象）
- index（字符串）：领导索引的名称，应为其删除指定的跟随者保留租约
- follower_cluster（可选，字符串）
- follower_index（可选，字符串）
- follower_index_uuid（可选，字符串）
- leader_remote_cluster（可选，字符串）

获取自动跟随模式编辑

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

端点文档

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

参数编辑

请求（对象）
- name（可选，字符串）：指定要检索的自动跟随模式集合。如果未指定名称，则 API 将返回所有集合的信息。

暂停自动跟随模式编辑

暂停自动跟随模式

端点文档

client.ccr.pauseAutoFollowPattern({ name })

参数编辑

请求（对象）
- name（字符串）：应暂停发现要跟随的新索引的自动跟随模式的名称。

暂停跟随编辑

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

端点文档

client.ccr.pauseFollow({ index })

参数编辑

请求（对象）
- index（字符串）：应暂停跟随其领导索引的跟随索引的名称。

放置自动跟随模式编辑

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

端点文档

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

参数编辑

请求（对象）
- name （字符串）：自动跟随模式集合的名称。
- remote_cluster （字符串）：包含要匹配的领导者索引的远程集群。
- follow_index_pattern （可选，字符串）：跟随索引的名称。模板 {{leader_index}} 可用于从领导者索引的名称派生跟随索引的名称。当跟随数据流时，请使用 {{leader_index}}；CCR 不支持更改跟随数据流的后备索引的名称。
- leader_index_patterns （可选，字符串数组）：要与 remote_cluster 字段指定的远程集群中的索引匹配的简单索引模式数组。
- leader_index_exclusion_patterns （可选，字符串数组）：可用于排除索引被自动跟随的简单索引模式数组。远程集群中名称与一个或多个 leader_index_patterns 和一个或多个 leader_index_exclusion_patterns 匹配的索引将不会被跟随。
- max_outstanding_read_requests （可选，数字）：来自远程集群的未完成读取请求的最大数量。
- settings （可选，记录<字符串，用户定义的值>）：要从领导者索引覆盖的设置。请注意，某些设置无法覆盖（例如，index.number_of_shards）。
- max_outstanding_write_requests （可选，数字）：来自远程集群的未完成读取请求的最大数量。
- read_poll_timeout （可选，字符串 | -1 | 0）：当跟随索引与领导者索引同步时，等待远程集群上的新操作的最长时间。当超时后，对操作的轮询将返回到跟随者，以便它可以更新一些统计信息。然后跟随者将立即尝试再次从领导者读取。
- max_read_request_operation_count （可选，数字）：每次从远程集群读取时要提取的最大操作数。
- max_read_request_size （可选，数字 | 字符串）：每次从远程集群读取一批操作的最大字节大小。
- max_retry_delay （可选，字符串 | -1 | 0）：重试异常失败的操作之前的最长等待时间。重试时采用指数退避策略。
- max_write_buffer_count （可选，数字）：可以排队写入的最大操作数。达到此限制后，将延迟从远程集群读取，直到排队的操作数低于限制。
- max_write_buffer_size （可选，数字 | 字符串）：可以排队写入的操作的最大总字节数。达到此限制后，将延迟从远程集群读取，直到排队的操作的总字节数低于限制。
- max_write_request_operation_count （可选，数字）：在跟随者上执行的每个批量写入请求的最大操作数。
- max_write_request_size （可选，数字 | 字符串）：在跟随者上执行的每个批量写入请求的最大操作总字节数。

resume_auto_follow_pattern编辑

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

端点文档

client.ccr.resumeAutoFollowPattern({ name })

参数编辑

请求（对象）
- name （字符串）：要恢复发现要跟随的新索引的自动跟随模式的名称。

resume_follow编辑

恢复已暂停的跟随索引

端点文档

client.ccr.resumeFollow({ index })

参数编辑

请求（对象）
- index （字符串）：要恢复跟随的跟随索引的名称。
- max_outstanding_read_requests（可选，数字）
- max_outstanding_write_requests（可选，数字）
- max_read_request_operation_count（可选，数字）
- max_read_request_size（可选，字符串）
- max_retry_delay（可选，字符串 | -1 | 0）
- max_write_buffer_count（可选，数字）
- max_write_buffer_size（可选，字符串）
- max_write_request_operation_count（可选，数字）
- max_write_request_size（可选，字符串）
- read_poll_timeout（可选，字符串 | -1 | 0）

stats编辑

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

端点文档

client.ccr.stats()

unfollow编辑

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

端点文档

client.ccr.unfollow({ index })

参数编辑

请求（对象）
- index （字符串）：应转换为常规索引的跟随索引的名称。

集群编辑

allocation_explain编辑

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

端点文档

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

参数编辑

请求（对象）
- current_node （可选，字符串）：指定节点 ID 或节点名称，以仅说明当前位于指定节点上的分片。
- index （可选，字符串）：指定要为其提供说明的索引的名称。
- primary （可选，布尔值）：如果为 true，则返回给定分片 ID 的主分片的说明。
- shard （可选，数字）：指定要为其提供说明的分片的 ID。
- include_disk_info （可选，布尔值）：如果为 true，则返回有关磁盘使用情况和分片大小的信息。
- include_yes_decisions （可选，布尔值）：如果为 true，则在说明中返回 YES 决定。

delete_component_template编辑

删除组件模板

端点文档

client.cluster.deleteComponentTemplate({ name })

参数编辑

请求（对象）
- name （字符串 | 字符串数组）：用于限制请求的组件模板名称的列表或通配符表达式。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

delete_voting_config_exclusions编辑

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

端点文档

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

参数编辑

请求（对象）
- wait_for_removal （可选，布尔值）：指定在清除投票配置排除项列表之前是否等待所有排除的节点从集群中删除。默认为 true，这意味着在执行任何操作之前，必须先从集群中删除所有排除的节点。如果设置为 false，则即使某些排除的节点仍在集群中，也会清除投票配置排除项列表。

exists_component_template编辑

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

端点文档

client.cluster.existsComponentTemplate({ name })

参数编辑

请求（对象）
- name （字符串 | 字符串数组）：用于限制请求的组件模板名称列表。支持通配符 (*) 表达式。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- local （可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。默认为 false，这意味着从主节点检索信息。

get_component_template编辑

返回一个或多个组件模板

端点文档

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

参数编辑

请求（对象）
- name （可选，字符串）：用于限制请求的组件模板名称列表。支持通配符 (*) 表达式。
- flat_settings （可选，布尔值）：如果为 true，则以平面格式返回设置。
- include_defaults （可选，布尔值）：返回组件模板的所有默认配置（默认值：false）
- local （可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。如果为 false，则从主节点检索信息。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

get_settings编辑

返回集群设置。

端点文档

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

参数编辑

请求（对象）
- flat_settings （可选，布尔值）：如果为 true，则以平面格式返回设置。
- include_defaults （可选，布尔值）：如果为 true，则从本地节点返回默认集群设置。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

health编辑

返回有关集群运行状况的基本信息。

端点文档

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

参数编辑

请求（对象）
- index （可选，字符串 | 字符串数组）：用于限制请求的数据流、索引和索引别名列表。支持通配符表达式 (*)。要定位集群中的所有数据流和索引，请省略此参数或使用 _all 或 *。
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：是否将通配符表达式扩展到打开、关闭或同时打开和关闭的具体索引。
- level （可选，枚举（“cluster” | “indices” | “shards”））：可以是 cluster、indices 或 shards 之一。控制返回的运行状况信息的详细程度。
- local （可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。默认为 false，这意味着从主节点检索信息。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_active_shards （可选，数字 | 枚举（“all” | “index-setting”））：控制要等待的活动分片数量，all 表示等待集群中的所有分片都处于活动状态，0 表示不等待。
- wait_for_events （可选，枚举（“immediate” | “urgent” | “high” | “normal” | “low” | “languid”））：可以是 immediate、urgent、high、normal、low、languid 之一。等到所有当前排队的具有给定优先级的事件都处理完毕。
- wait_for_nodes （可选，字符串 | 数字）：请求将一直等待，直到指定数量 N 的节点可用。它也接受 >=N、⇐N、>N 和 <N。或者，可以使用 ge(N)、le(N)、gt(N) 和 lt(N) 表示法。
- wait_for_no_initializing_shards （可选，布尔值）：一个布尔值，控制是否等待（直到提供的超时时间）集群中没有分片初始化。默认为 false，这意味着它不会等待初始化分片。
- wait_for_no_relocating_shards （可选，布尔值）：一个布尔值，控制是否等待（直到提供的超时时间）集群中没有分片迁移。默认为 false，这意味着它不会等待迁移分片。
- wait_for_status （可选，枚举（"green" | "yellow" | "red"））：绿色、黄色或红色之一。将等待（直到提供的超时时间），直到集群状态变为提供的值或更好，即绿色 > 黄色 > 红色。默认情况下，不会等待任何状态。

信息编辑

返回有关集群的不同信息。

端点文档

client.cluster.info({ target })

参数编辑

请求（对象）
- target （枚举（"_all" | "http" | "ingest" | "thread_pool" | "script"） | 枚举（"_all" | "http" | "ingest" | "thread_pool" | "script"）[]）：将返回的信息限制为特定目标。支持列表，例如 http,ingest。

待处理任务编辑

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

端点文档

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

参数编辑

请求（对象）
- local （可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。如果为 false，则从主节点检索信息。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

投票配置排除编辑

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

端点文档

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

参数编辑

请求（对象）
- node_names （可选，字符串 | 字符串[]）：要从投票配置中排除的节点名称列表。如果指定，则不得同时指定 node_ids。
- node_ids （可选，字符串 | 字符串[]）：要从投票配置中排除的节点持久 ID 列表。如果指定，则不得同时指定 node_names。
- timeout （可选，字符串 | -1 | 0）：添加投票配置排除时，API 会等待指定的节点从投票配置中排除，然后再返回。如果在满足适当条件之前超时，则请求失败并返回错误。

放置组件模板编辑

创建或更新组件模板

端点文档

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

参数编辑

请求（对象）
- name （字符串）：要创建的组件模板的名称。Elasticsearch 包括以下内置组件模板：logs-mappings；'logs-settings'；metrics-mappings；metrics-settings；synthetics-mapping；synthetics-settings。Elastic Agent 使用这些模板为其数据流配置支持索引。如果您使用 Elastic Agent 并想覆盖其中一个模板，请将替换模板的 version 设置为高于当前版本。如果您不使用 Elastic Agent 并希望禁用所有内置组件和索引模板，请使用集群更新设置 API 将 stack.templates.enabled 设置为 false。
- template （{ aliases、mappings、settings、defaults、data_stream、lifecycle }）：要应用的模板，包括映射、设置或别名配置。
- version （可选，数字）：用于在外部管理组件模板的版本号。此编号不是由 Elasticsearch 自动生成或递增的。要取消设置版本，请在不指定版本的情况下替换模板。
- _meta （可选，记录<字符串，用户定义的值>）：有关组件模板的可选用户元数据。可以有任何内容。此映射不是由 Elasticsearch 自动生成的。此信息存储在集群状态中，因此最好保持简短。要取消设置 _meta，请在不指定此信息的情况下替换模板。
- deprecated （可选，布尔值）：将此索引模板标记为已弃用。创建或更新使用已弃用组件的未弃用索引模板时，Elasticsearch 将发出弃用警告。
- create （可选，布尔值）：如果为 true，则此请求不能替换或更新现有的组件模板。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

放置设置编辑

更新集群设置。

端点文档

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

参数编辑

请求（对象）
- persistent （可选，记录<字符串，用户定义的值>）
- transient （可选，记录<字符串，用户定义的值>）
- flat_settings （可选，布尔值）：以平面格式返回设置（默认值：false）
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时
- timeout （可选，字符串 | -1 | 0）：显式操作超时

远程信息编辑

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

端点文档

client.cluster.remoteInfo()

重新路由编辑

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

端点文档

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

参数编辑

请求（对象）
- commands （可选，{ cancel、move、allocate_replica、allocate_stale_primary、allocate_empty_primary }[]）：定义要执行的命令。
- dry_run （可选，布尔值）：如果为 true，则请求仅模拟操作并返回结果状态。
- explain （可选，布尔值）：如果为 true，则响应包含有关命令可以执行或不能执行的原因的说明。
- metric （可选，字符串 | 字符串[]）：将返回的信息限制为指定的指标。
- retry_failed （可选，布尔值）：如果为 true，则重试由于连续分配失败次数过多而被阻止的分片的分配。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

状态编辑

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

端点文档

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

参数编辑

请求（对象）
- metric （可选，字符串 | 字符串[]）：将返回的信息限制为指定的指标
- index （可选，字符串 | 字符串[]）：索引名称列表；使用 _all 或空字符串对所有索引执行操作
- allow_no_indices （可选，布尔值）：是否忽略通配符索引表达式解析为无具体索引的情况。（这包括 _all 字符串或未指定任何索引时）
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：是否将通配符表达式扩展到打开、关闭或同时打开和关闭的具体索引。
- flat_settings （可选，布尔值）：以平面格式返回设置（默认值：false）
- ignore_unavailable （可选，布尔值）：当指定的具体索引不可用（丢失或关闭）时是否应忽略它们
- local （可选，布尔值）：返回本地信息，不从主节点检索状态（默认值：false）
- master_timeout（可选，字符串 | -1 | 0）：指定连接到主节点的超时时间
- wait_for_metadata_version （可选，数字）：等待元数据版本等于或大于指定的元数据版本
- wait_for_timeout （可选，字符串 | -1 | 0）：等待 wait_for_metadata_version 的最长时间，超时后将超时

统计信息编辑

返回集群统计信息的概览。

端点文档

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

参数编辑

请求（对象）
- node_id （可选，字符串 | 字符串[]）：用于限制返回信息的节点过滤器列表。默认为集群中的所有节点。
- flat_settings （可选，布尔值）：如果为 true，则以平面格式返回设置。
- timeout （可选，字符串 | -1 | 0）：等待每个节点响应的时间段。如果节点在其超时到期之前未响应，则响应不包括其统计信息。但是，超时的节点包含在响应的 _nodes.failed 属性中。默认为无超时。

孤立索引编辑

删除孤立索引编辑

删除指定的孤立索引

端点文档

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

参数编辑

请求（对象）
- index_uuid （字符串）：孤立索引的 UUID
- accept_data_loss （布尔值）：必须设置为 true 才能删除孤立索引
- master_timeout（可选，字符串 | -1 | 0）：指定连接到主节点的超时时间
- timeout （可选，字符串 | -1 | 0）：显式操作超时

导入孤立索引编辑

导入指定的孤立索引

端点文档

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

参数编辑

请求（对象）
- index_uuid （字符串）：孤立索引的 UUID
- accept_data_loss （布尔值）：必须设置为 true 才能导入孤立索引
- master_timeout（可选，字符串 | -1 | 0）：指定连接到主节点的超时时间
- timeout （可选，字符串 | -1 | 0）：显式操作超时

列出孤立索引编辑

返回所有孤立索引。

端点文档

client.danglingIndices.listDanglingIndices()

充实编辑

删除策略编辑

删除现有的充实策略及其充实索引。

端点文档

client.enrich.deletePolicy({ name })

参数编辑

请求（对象）
- name （字符串）：要删除的充实策略。

execute_policy编辑

为现有的充实策略创建充实索引。

端点文档

client.enrich.executePolicy({ name })

参数编辑

请求（对象）
- name（字符串）：要执行的充实策略。
- wait_for_completion（可选，布尔值）：如果为 true，则请求会阻止其他充实策略执行请求，直到完成。

get_policy编辑

获取有关充实策略的信息。

端点文档

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

参数编辑

请求（对象）
- name（可选，字符串 | 字符串数组）：用于限制请求的充实策略名称列表。要返回所有充实策略的信息，请省略此参数。

put_policy编辑

创建一个新的充实策略。

端点文档

client.enrich.putPolicy({ name })

参数编辑

请求（对象）
- name（字符串）：要创建或更新的充实策略的名称。
- geo_match（可选，{ enrich_fields、indices、match_field、query、name、elasticsearch_version }）：根据 geo_shape 查询将充实数据与传入文档匹配。
- match（可选，{ enrich_fields、indices、match_field、query、name、elasticsearch_version }）：根据 term 查询将充实数据与传入文档匹配。
- range（可选，{ enrich_fields、indices、match_field、query、name、elasticsearch_version }）：根据 term 查询将传入文档中的数字、日期或 IP 地址与充实索引中的范围匹配。

stats编辑

获取充实协调器统计信息以及当前正在执行的充实策略的相关信息。

端点文档

client.enrich.stats()

eql编辑

delete编辑

按 ID 删除异步 EQL 搜索。如果搜索仍在运行，则搜索请求将被取消。否则，将删除保存的搜索结果。

端点文档

client.eql.delete({ id })

参数编辑

请求（对象）
- id（字符串）：要删除的搜索的标识符。EQL 搜索 API 的异步搜索响应中提供了搜索 ID。如果请求的 keep_on_completion 参数为 true，也会提供搜索 ID。

get编辑

从先前执行的事件查询语言 (EQL) 搜索返回异步结果

端点文档

client.eql.get({ id })

参数编辑

请求（对象）
- id（字符串）：搜索的标识符。
- keep_alive（可选，字符串 | -1 | 0）：搜索及其结果在集群上存储的时间段。默认为搜索的 EQL 搜索 API 请求设置的 keep_alive 值。
- wait_for_completion_timeout（可选，字符串 | -1 | 0）：等待请求完成的超时持续时间。默认为无超时，这意味着请求将等待完整的搜索结果。

get_status编辑

返回先前提交的异步或存储的事件查询语言 (EQL) 搜索的状态

端点文档

client.eql.getStatus({ id })

参数编辑

请求（对象）
- id（字符串）：搜索的标识符。

search编辑

返回与事件查询语言 (EQL) 中表达的查询匹配的结果

端点文档

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

参数编辑

请求（对象）
- index（字符串 | 字符串数组）：要将操作范围限定到的索引的名称
- query（字符串）：您要运行的 EQL 查询。
- case_sensitive（可选，布尔值）
- event_category_field（可选，字符串）：包含事件分类的字段，例如进程、文件或网络。
- tiebreaker_field（可选，字符串）：用于按时间戳升序对匹配项进行排序的字段
- timestamp_field（可选，字符串）：包含事件时间戳的字段。默认值为“@timestamp”
- fetch_size（可选，数字）：每次搜索的序列查询的最大事件数。
- filter（可选，{ 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_query、script、script_score、shape、simple_query_string、span_containing、span_field_masking、span_first、span_multi、span_near、span_not、span_or、span_term、span_within、term、terms、terms_set、text_expansion、weighted_tokens、wildcard、wrapper、type } | { 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_query、script、script_score、shape、simple_query_string、span_containing、span_field_masking、span_first、span_multi、span_near、span_not、span_or、span_term、span_within、term、terms、terms_set、text_expansion、weighted_tokens、wildcard、wrapper、type }[]）：使用查询 DSL 编写的查询，用于筛选运行 EQL 查询的事件。
- keep_alive（可选，字符串 | -1 | 0）
- keep_on_completion（可选，布尔值）
- wait_for_completion_timeout（可选，字符串 | -1 | 0）
- size（可选，数字）：对于基本查询，要返回的最大匹配事件数。默认为 10
- fields（可选，{ field、format、include_unmapped } | { field、format、include_unmapped }[]）：通配符 (*) 模式数组。响应返回与每个匹配项的字段属性中的这些模式匹配的字段名称的值。
- result_position（可选，枚举（“tail” | “head”））
- runtime_mappings（可选，记录<字符串，{ fetch_fields、format、input_field、target_field、target_index、script、type }>）
- allow_no_indices（可选，布尔值）
- expand_wildcards（可选，枚举（“all” | “open” | “closed” | “hidden” | “none”） | 枚举（“all” | “open” | “closed” | “hidden” | “none”）[]）
- ignore_unavailable（可选，boolean）：如果为 true，则响应中不包括缺失或关闭的索引。

esql编辑

async_query编辑

异步执行 ESQL 请求

端点文档

client.esql.asyncQuery()

async_query_get编辑

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

端点文档

client.esql.asyncQueryGet()

query编辑

执行 ESQL 请求

端点文档

client.esql.query({ query })

参数编辑

请求（对象）
- query（字符串）：ES|QL 查询 API 接受查询参数中的 ES|QL 查询字符串，运行它并返回结果。
- columnar（可选，布尔值）：默认情况下，ES|QL 以行形式返回结果。例如，FROM 将每个单独的文档作为一行返回。对于 JSON、YAML、CBOR 和 smile 格式，ES|QL 可以以列的形式返回结果，其中一行代表结果中某个列的所有值。
- filter（可选，{ 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_query、script、script_score、shape、simple_query_string、span_containing、span_field_masking、span_first、span_multi、span_near、span_not、span_or、span_term、span_within、term、terms、terms_set、text_expansion、weighted_tokens、wildcard、wrapper、type }）：在 filter 参数中指定查询 DSL 查询，以筛选 ES|QL 查询在其上运行的文档集。
- locale（可选，字符串）
- params（可选，数字 | 数字 | 字符串 | 布尔值 | 空值数组）：为避免任何黑客攻击或代码注入尝试，请在单独的参数列表中提取值。对每个参数使用问号占位符 (?)。
- format（可选，字符串）：Accept 标头的简短版本，例如 json、yaml。
- delimiter（可选，字符串）：CSV 行中各值之间使用的字符。仅对 CSV 格式有效。

features编辑

get_features编辑

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

端点文档

client.features.getFeatures()

reset_features编辑

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

端点文档

client.features.resetFeatures()

fleet编辑

global_checkpoints编辑

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

端点文档

client.fleet.globalCheckpoints({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串）：解析为单个索引的单个索引或索引别名。
- wait_for_advance（可选，布尔值）：一个布尔值，用于控制是否等待（直到超时）全局检查点前进到提供的 checkpoints 之后。
- wait_for_index（可选，布尔值）：一个布尔值，用于控制是否等待（直到超时）目标索引存在并且所有主分片都处于活动状态。仅当 wait_for_advance 为 true 时，此值才能为 true。
- checkpoints（可选，数字数组）：以前全局检查点的逗号分隔列表。与 wait_for_advance 结合使用时，API 仅在全局检查点超过这些检查点后才会返回。提供空列表将导致 Elasticsearch 立即返回当前的全局检查点。
- timeout（可选，字符串 | -1 | 0）：等待全局检查点超过 checkpoints 的时间段。

msearch编辑

多重搜索 API，其中仅在指定检查点因刷新而可用后才会执行搜索。此 API 专为 Fleet 服务器项目的内部使用而设计。

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

参数编辑

请求（对象）
- index（可选，字符串 | 字符串）：要搜索的单个目标。如果目标是索引别名，则它必须解析为单个索引。
- searches （可选，{ allow_no_indices, expand_wildcards, ignore_unavailable, index, preference, request_cache, routing, search_type, ccs_minimize_roundtrips, allow_partial_search_results, ignore_throttled } | { aggregations, collapse, query, explain, ext, stored_fields, docvalue_fields, knn, from, highlight, indices_boost, min_score, post_filter, profile, rescore, script_fields, search_after, size, sort, _source, fields, terminate_after, stats, timeout, track_scores, track_total_hits, version, runtime_mappings, seq_no_primary_term, pit, suggest }[]）
- allow_no_indices（可选，boolean）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。例如，如果一个索引以 foo 开头但没有索引以 bar 开头，则针对 foo*,bar* 的请求将返回错误。
- ccs_minimize_roundtrips（可选，boolean）：如果为 true，则针对跨集群搜索请求，将最小化协调节点与远程集群之间的网络往返次数。
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：通配符表达式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。
- ignore_throttled（可选，boolean）：如果为 true，则在冻结时将忽略具体的、已扩展的或已设置别名的索引。
- ignore_unavailable（可选，boolean）：如果为 true，则响应中不包括缺失或关闭的索引。
- max_concurrent_searches（可选，number）：多重搜索 API 可以执行的最大并发搜索数。
- max_concurrent_shard_requests（可选，number）：每个子搜索请求在每个节点上执行的最大并发分片请求数。
- pre_filter_shard_size（可选，number）：定义一个阈值，如果搜索请求扩展到的分片数超过该阈值，则强制执行预过滤往返，以便根据查询重写来预过滤搜索分片。如果例如分片无法根据其重写方法匹配任何文档（例如，如果日期过滤器是匹配的强制性条件，但分片边界和查询是不相交的），则此过滤器往返可以显著限制分片数。
- search_type（可选，Enum("query_then_fetch" | "dfs_query_then_fetch"))：指示在对返回的文档进行评分时是否应使用全局词条和文档频率。
- rest_total_hits_as_int（可选，boolean）：如果为 true，则在响应中将 hits.total 作为整数返回。默认为 false，它返回一个对象。
- typed_keys（可选，boolean）：指定在响应中聚合和建议器名称是否应以其各自的类型作为前缀。
- wait_for_checkpoints（可选，数字数组）：检查点的逗号分隔列表。配置后，仅在相关检查点对搜索可见后，才会在分片上执行搜索 API。默认为空列表，这将导致 Elasticsearch 立即执行搜索。
- allow_partial_search_results（可选，布尔值）：如果为 true，则在出现分片请求超时或[分片故障](https://elastic.ac.cn/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures)时返回部分结果。如果为 false，则返回错误，并且不返回部分结果。默认为已配置的集群设置 search.default_allow_partial_results，该设置默认情况下为 true。

search编辑

搜索 API，其中仅在指定检查点因刷新而可用后才会执行搜索。此 API 专为 Fleet 服务器项目的内部使用而设计。

client.fleet.search({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串）：要搜索的单个目标。如果目标是索引别名，则它必须解析为单个索引。
- aggregations （可选，记录<字符串，{ aggregations, meta, adjacency_matrix, auto_date_histogram, avg, avg_bucket, boxplot, bucket_script, bucket_selector, bucket_sort, bucket_count_ks_test, bucket_correlation, cardinality, categorize_text, children, composite, cumulative_cardinality, cumulative_sum, date_histogram, date_range, derivative, diversified_sampler, extended_stats, extended_stats_bucket, frequent_item_sets, filter, filters, geo_bounds, geo_centroid, geo_distance, geohash_grid, geo_line, geotile_grid, geohex_grid, global, histogram, ip_range, ip_prefix, inference, line, matrix_stats, max, max_bucket, median_absolute_deviation, min, min_bucket, missing, moving_avg, moving_percentiles, moving_fn, multi_terms, nested, normalize, parent, percentile_ranks, percentiles, percentiles_bucket, range, rare_terms, rate, reverse_nested, sampler, scripted_metric, serial_diff, significant_terms, significant_text, stats, stats_bucket, string_stats, sum, sum_bucket, terms, top_hits, t_test, top_metrics, value_count, weighted_avg, variable_width_histogram }>）
- collapse （可选，{ field, inner_hits, max_concurrent_group_searches, collapse }）
- explain (可选, 布尔值): 如果为 true，则作为命中的一部分返回有关分数计算的详细信息。
- ext (可选, 记录<字符串, 用户定义的值>): Elasticsearch 插件定义的搜索扩展的配置。
- from （可选，数字）：开始文档偏移量。默认情况下，您不能使用 from 和 size 参数对超过 10,000 个匹配结果进行分页。要对更多匹配结果进行分页，请使用 search_after 参数。
- highlight （可选，{ encoder, fields }）
- track_total_hits （可选，布尔值 | 数字）：要准确计数的与查询匹配的匹配结果数。如果为 true，则返回确切的匹配结果数，但会降低一些性能。如果为 false，则响应不包括与查询匹配的匹配结果总数。默认为 10,000 个匹配结果。
- indices_boost (可选, 记录<字符串, 数字>[]): 提高指定索引中文档的 _score。
- docvalue_fields （可选，{ field, format, include_unmapped }[]）：通配符 (*) 模式数组。请求返回与响应的 hits.fields 属性中的这些模式匹配的字段名称的文档值。
- min_score （可选，数字）：匹配文档的最低 _score。 _score 低于此值的文档不包含在搜索结果中。
- post_filter （可选，{ 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）
- profile （可选，布尔值）
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })：使用查询 DSL 定义搜索定义。
- rescore （可选，{ window_size, query, learning_to_rank } | { window_size, query, learning_to_rank }[]）
- script_fields (可选, 记录<字符串, { script, ignore_failure }>): 检索每个命中的脚本评估（基于不同的字段）。
- search_after （可选，数字 | 数字 | 字符串 | 布尔值 | null | 用户自定义值[]）
- size （可选，数字）：要返回的匹配数量。默认情况下，使用 from 和 size 参数不能对超过 10,000 个匹配进行分页。要对更多匹配进行分页，请使用 search_after 参数。
- slice （可选，{ field, id, max }）
- sort （可选，字符串 | { _score, _doc, _geo_distance, _script } | 字符串 | { _score, _doc, _geo_distance, _script }[]）
- _source（可选，布尔值 | { excludes, includes }）：指示为匹配文档返回哪些源字段。这些字段在搜索响应的 hits._source 属性中返回。
- fields （可选，{ field, format, include_unmapped }[]）：通配符 (*) 模式数组。请求返回响应的 hits.fields 属性中与这些模式匹配的字段名称的值。
- suggest （可选，{ text }）
- terminate_after （可选，数字）：为每个分片收集的最大文档数。如果查询达到此限制，Elasticsearch 会提前终止查询。Elasticsearch 在排序之前收集文档。默认为 0，不会提前终止查询执行。
- timeout（可选，字符串）：指定等待每个分片响应的时间段。如果在超时到期之前没有收到响应，则请求失败并返回错误。默认为无超时。
- track_scores（可选，布尔值）：如果为 true，则计算并返回文档分数，即使分数不用于排序。
- version（可选，布尔值）：如果为 true，则返回文档版本作为匹配结果的一部分。
- seq_no_primary_term （可选，布尔值）：如果为 true，则返回每次匹配的最后一次修改的序列号和主项。请参阅乐观并发控制。
- stored_fields（可选，字符串 | 字符串数组）：要作为命中的一部分返回的存储字段列表。如果未指定任何字段，则响应中不包含任何存储字段。如果指定了此字段，则 _source 参数默认为 false。您可以传递 _source: true 以在搜索响应中同时返回源字段和存储字段。
- pit （可选，{ id, keep_alive }）：将搜索限制在某个时间点 (PIT)。如果提供 PIT，则无法在请求路径中指定 <index>。
- runtime_mappings（可选，Record<string, { fetch_fields, format, input_field, target_field, target_index, script, type }>）：在搜索请求中定义一个或多个运行时字段。这些字段优先于具有相同名称的映射字段。
- stats（可选，字符串[]）：要与搜索关联的统计信息组。每个组都为其关联的搜索维护一个统计信息聚合。您可以使用索引统计信息 API 检索这些统计信息。
- allow_no_indices（可选，布尔值）
- analyzer（可选，字符串）
- analyze_wildcard（可选，布尔值）
- batched_reduce_size（可选，数字）
- ccs_minimize_roundtrips（可选，布尔值）
- default_operator（可选，枚举（"and" | "or"））
- df（可选，字符串）
- expand_wildcards（可选，枚举（“all” | “open” | “closed” | “hidden” | “none”） | 枚举（“all” | “open” | “closed” | “hidden” | “none”）[]）
- ignore_throttled（可选，布尔值）
- ignore_unavailable（可选，布尔值）
- lenient（可选，布尔值）
- max_concurrent_shard_requests（可选，数字）
- min_compatible_shard_node （可选，字符串）
- preference（可选，字符串）
- pre_filter_shard_size（可选，数字）
- request_cache（可选，布尔值）
- routing（可选，字符串）
- scroll （可选，字符串 | -1 | 0）
- search_type（可选，枚举（"query_then_fetch" | "dfs_query_then_fetch"））
- suggest_field（可选，字符串）：指定用于建议的字段。
- suggest_mode（可选，枚举（"missing" | "popular" | "always"））
- suggest_size（可选，数字）
- suggest_text （可选，字符串）：应为其返回建议的源文本。
- typed_keys（可选，布尔值）
- rest_total_hits_as_int （可选，布尔值）
- _source_excludes（可选，字符串 | 字符串数组）
- _source_includes（可选，字符串 | 字符串数组）
- q（可选，字符串）
- wait_for_checkpoints（可选，数字数组）：检查点的逗号分隔列表。配置后，仅在相关检查点对搜索可见后，才会在分片上执行搜索 API。默认为空列表，这将导致 Elasticsearch 立即执行搜索。
- allow_partial_search_results（可选，布尔值）：如果为 true，则在出现分片请求超时或[分片故障](https://elastic.ac.cn/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures)时返回部分结果。如果为 false，则返回错误，并且不返回部分结果。默认为已配置的集群设置 search.default_allow_partial_results，该设置默认情况下为 true。

graph编辑

explore编辑

探索有关索引中文档和术语的提取和汇总信息。

端点文档

client.graph.explore({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串数组）：索引的名称。
- connections（可选，{connections, query, vertices}）：指定要从中提取与指定顶点关联的术语的一个或多个字段。
- controls（可选，{sample_diversity, sample_size, timeout, use_significance}）：指示 Graph API 如何构建图形。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type}）：标识感兴趣文档的种子查询。可以是任何有效的 Elasticsearch 查询。
- vertices（可选，{exclude, field, include, min_doc_count, shard_min_doc_count, size}[]）：指定一个或多个字段，这些字段包含要作为顶点包含在图形中的术语。
- routing （可选，字符串）：用于将操作路由到特定分片的自定义值。
- timeout（可选，字符串 | -1 | 0）：指定等待来自每个分片的响应的时间段。如果在超时到期之前未收到响应，则请求失败并返回错误。默认为不超时。

ilm编辑

delete_lifecycle编辑

删除指定的生命周期策略定义。当前使用的策略无法删除。

端点文档

client.ilm.deleteLifecycle({ policy })

参数编辑

请求（对象）
- policy（字符串）：策略的标识符。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

explain_lifecycle编辑

检索有关索引的当前生命周期状态的信息，例如当前正在执行的阶段、操作和步骤。

端点文档

client.ilm.explainLifecycle({ index })

参数编辑

请求（对象）
- index（字符串）：要定位的数据流、索引和别名列表。支持通配符 (*)。要定位所有数据流和索引，请使用 * 或 _all。
- only_errors（可选，布尔值）：将返回的索引过滤为仅由 ILM 管理且处于错误状态的索引，这可能是由于在执行策略时遇到错误或尝试使用不存在的策略导致的。
- only_managed（可选，布尔值）：将返回的索引过滤为仅由 ILM 管理的索引。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

get_lifecycle编辑

返回指定的策略定义。包括策略版本和上次修改日期。

端点文档

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

参数编辑

请求（对象）
- policy（可选，字符串）：策略的标识符。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

get_status编辑

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

端点文档

client.ilm.getStatus()

migrate_to_data_tiers编辑

将索引和 ILM 策略从自定义节点属性分配路由迁移到数据层路由

端点文档

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

参数编辑

请求（对象）
- legacy_template_to_delete（可选，字符串）
- node_attribute（可选，字符串）
- dry_run（可选，布尔值）：如果为 true，则模拟从基于节点属性的分配过滤器到数据层的迁移，但不执行迁移。这提供了一种检索需要迁移的索引和 ILM 策略的方法。

move_to_step编辑

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

端点文档

client.ilm.moveToStep({ index })

参数编辑

请求（对象）
- index（字符串）：要更改其生命周期步骤的索引的名称
- current_step（可选，{action, name, phase}）
- next_step（可选，{action, name, phase}）

put_lifecycle编辑

创建生命周期策略

端点文档

client.ilm.putLifecycle({ policy })

参数编辑

请求（对象）
- policy（字符串）：策略的标识符。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

remove_policy编辑

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

端点文档

client.ilm.removePolicy({ index })

参数编辑

请求（对象）
- index（字符串）：要删除其策略的索引的名称

retry编辑

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

端点文档

client.ilm.retry({ index })

参数编辑

请求（对象）
- index（字符串）：要重试其失败的生命周期步骤的索引的名称（以逗号分隔）

start编辑

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

端点文档

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

参数编辑

请求（对象）
- master_timeout（可选，字符串 | -1 | 0）
- timeout（可选，字符串 | -1 | 0）

stop编辑

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

端点文档

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

参数编辑

请求（对象）
- master_timeout（可选，字符串 | -1 | 0）
- timeout（可选，字符串 | -1 | 0）

索引编辑

add_block编辑

向索引添加块。

端点文档

client.indices.addBlock({ index, block })

参数编辑

请求（对象）
- index（字符串）：要添加块的索引的逗号分隔列表
- block（枚举（“metadata” | “read” | “read_only” | “write”））：要添加的块（读取、写入、只读或元数据之一）
- allow_no_indices （可选，布尔值）：是否忽略通配符索引表达式解析为无具体索引的情况。（这包括 _all 字符串或未指定任何索引时）
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：是否将通配符表达式扩展到打开、关闭或同时打开和关闭的具体索引。
- ignore_unavailable （可选，布尔值）：当指定的具体索引不可用（丢失或关闭）时是否应忽略它们
- master_timeout（可选，字符串 | -1 | 0）：指定连接到主节点的超时时间
- timeout （可选，字符串 | -1 | 0）：显式操作超时

analyze编辑

对文本执行分析过程并返回文本的标记分解。

端点文档

client.indices.analyze({ ... })

参数编辑

请求（对象）
- index（可选，字符串）：用于派生分析器的索引。如果指定，则 analyzer 或字段参数将覆盖此值。如果未指定索引或索引没有默认分析器，则 analyze API 将使用标准分析器。
- analyzer（可选，字符串）：应应用于提供的 text 的分析器的名称。这可以是内置分析器，也可以是在索引中配置的分析器。
- attributes（可选，字符串[]）：用于过滤 explain 参数输出的标记属性数组。
- char_filter（可选，字符串 | { type, escaped_tags } | { type, mappings, mappings_path } | { type, flags, pattern, replacement } | { type, mode, name } | { type, normalize_kana, normalize_kanji }[]）：用于在标记器之前预处理字符的字符过滤器数组。
- explain（可选，布尔值）：如果为 true，则响应将包含标记属性和其他详细信息。
- field（可选，字符串）：用于派生分析器的字段。要使用此参数，您必须指定一个索引。如果指定，则 analyzer 参数将覆盖此值。
- filter（可选，字符串 | { type, preserve_original } | { type, common_words, common_words_path, ignore_case, query_mode } | { type, filter, script } | { type, delimiter, encoding } | { type, max_gram, min_gram, side, preserve_original } | { type, articles, articles_path, articles_case } | { type, max_output_size, separator } | { type, dedup, dictionary, locale, longest_only } | { type } | { type, mode, types } | { type, keep_words, keep_words_case, keep_words_path } | { type, ignore_case, keywords, keywords_path, keywords_pattern } | { type } | { type, max, min } | { type, consume_all_tokens, max_token_count } | { type, language } | { type, filters, preserve_original } | { type, max_gram, min_gram, preserve_original } | { type, stoptags } | { type, patterns, preserve_original } | { type, all, flags, pattern, replacement } | { type } | { type, script } | { type } | { type } | { type, filler_token, max_shingle_size, min_shingle_size, output_unigrams, output_unigrams_if_no_shingles, token_separator } | { type, language } | { type, rules, rules_path } | { type, language } | { type, ignore_case, remove_trailing, stopwords, stopwords_path } | { type, expand, format, lenient, synonyms, synonyms_path, synonyms_set, tokenizer, updateable } | { type, expand, format, lenient, synonyms, synonyms_path, synonyms_set, tokenizer, updateable } | { type } | { type, length } | { type, only_on_same_position } | { type } | { type, adjust_offsets, catenate_all, catenate_numbers, catenate_words, generate_number_parts, generate_word_parts, ignore_keywords, preserve_original, protected_words, protected_words_path, split_on_case_change, split_on_numerics, stem_english_possessive, type_table, type_table_path } | { type, catenate_all, catenate_numbers, catenate_words, generate_number_parts, generate_word_parts, preserve_original, protected_words, protected_words_path, split_on_case_change, split_on_numerics, stem_english_possessive, type_table, type_table_path } | { type, minimum_length } | { type, use_romaji } | { type, stoptags } | { type, alternate, case_first, case_level, country, decomposition, hiragana_quaternary_mode, language, numeric, rules, strength, variable_top, variant } | { type, unicode_set_filter } | { type, name } | { type, dir, id } | { type, encoder, languageset, max_code_len, name_type, replace, rule_type } | { type }[]）：用于在标记器之后应用的标记过滤器数组。
- normalizer（可选，字符串）：用于将文本转换为单个标记的规范化器。
- text（可选，字符串 | 字符串[]）：要分析的文本。如果提供字符串数组，则将其作为多值字段进行分析。
- tokenizer（可选，字符串 | { type, tokenize_on_chars, max_token_length } | { type, custom_token_chars, max_gram, min_gram, token_chars } | { type, buffer_size } | { type } | { type } | { type, custom_token_chars, max_gram, min_gram, token_chars } | { type, decompound_mode, discard_punctuation, user_dictionary, user_dictionary_rules } | { type, buffer_size, delimiter, replacement, reverse, skip } | { type, max_token_length } | { type, max_token_length } | { type, max_token_length } | { type, discard_punctuation, mode, nbest_cost, nbest_examples, user_dictionary, user_dictionary_rules, discard_compound_token } | { type, flags, group, pattern } | { type, rule_files }）：用于将文本转换为标记的标记器。

clear_cache编辑

清除一个或多个索引的所有或特定缓存。

端点文档

client.indices.clearCache({ ... })

参数编辑

请求（对象）
- index（可选，string | string[]）：用于限制请求的数据流、索引和别名列表。支持通配符（*）。要定位所有数据流和索引，请省略此参数或使用*或_all。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- fielddata（可选，布尔值）：如果为 true，则清除字段缓存。使用 fields 参数仅清除特定字段的缓存。
- fields（可选，字符串 | 字符串[]）：用于限制 fielddata 参数的字段名称列表。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- query（可选，布尔值）：如果为 true，则清除查询缓存。
- request（可选，布尔值）：如果为 true，则清除请求缓存。

clone编辑

克隆索引

端点文档

client.indices.clone({ index, target })

参数编辑

请求（对象）
- index（字符串）：要克隆的源索引的名称。
- target（字符串）：要创建的目标索引的名称。
- aliases（可选，记录<字符串，{ filter，index_routing，is_hidden，is_write_index，routing，search_routing }>）：结果索引的别名。
- settings（可选，记录<字符串，用户定义的值>）：目标索引的配置选项。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

close编辑

关闭索引。

端点文档

client.indices.close({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串[]）：用于限制请求的索引名称的列表或通配符表达式。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

create编辑

创建具有可选设置和映射的索引。

端点文档

client.indices.create({ index })

参数编辑

请求（对象）
- index（字符串）：您要创建的索引的名称。
- aliases（可选，记录<字符串，{ filter，index_routing，is_hidden，is_write_index，routing，search_routing }>）：索引的别名。
- mappings（可选，{ all_field，date_detection，dynamic，dynamic_date_formats，dynamic_templates，_field_names，index_field，_meta，numeric_detection，properties，_routing，_size，_source，runtime，enabled，subobjects，_data_stream_timestamp }）：索引中字段的映射。如果指定，则此映射可以包括
  - 字段名称
  - 字段数据类型
  - 映射参数
- settings（可选，{ index，mode，routing_path，soft_deletes，sort，number_of_shards，number_of_replicas，number_of_routing_shards，check_on_startup，codec，routing_partition_size，load_fixed_bitset_filters_eagerly，hidden，auto_expand_replicas，merge，search，refresh_interval，max_result_window，max_inner_result_window，max_rescore_window，max_docvalue_fields_search，max_script_fields，max_ngram_diff，max_shingle_diff，blocks，max_refresh_listeners，analyze，highlight，max_terms_count，max_regex_length，routing，gc_deletes，default_pipeline，final_pipeline，lifecycle，provided_name，creation_date，creation_date_string，uuid，version，verified_before_close，format，max_slices_per_scroll，translog，query_string，priority，top_metrics_max_size，analysis，settings，time_series，queries，similarity，mapping，indexing.slowlog，indexing_pressure，store }）：索引的配置选项。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

create_data_stream编辑

创建数据流

端点文档

client.indices.createDataStream({ name })

参数编辑

请求（对象）
- name（字符串）：数据流的名称，必须符合以下条件：仅限小写字母；不能包含 \、/、*、?、"、<、>、|、,、#、: 或空格字符；不能以 -、_、+ 或 .ds- 开头；不能是 . 或 ..；长度不能超过 255 个字节。多字节字符计入此限制的速度更快。

data_streams_stats编辑

提供有关数据流中正在进行的操作的统计信息。

端点文档

client.indices.dataStreamsStats({ ... })

参数编辑

请求（对象）
- name （可选，字符串）：用于限制请求的数据流列表。支持通配符表达式 (*)。要定位集群中的所有数据流，请省略此参数或使用 *。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的数据流类型。支持值列表，例如 open,hidden。

删除编辑

删除索引。

端点文档

client.indices.delete({ index })

参数编辑

请求（对象）
- index （字符串 | 字符串[]）：要删除的索引列表。您不能指定索引别名。默认情况下，此参数不支持通配符 (*) 或 _all。要使用通配符或 _all，请将 action.destructive_requires_name 集群设置设置为 false。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

delete_alias编辑

删除别名。

端点文档

client.indices.deleteAlias({ index, name })

参数编辑

请求（对象）
- index （字符串 | 字符串[]）：用于限制请求的数据流或索引列表。支持通配符 (*)。
- name （字符串 | 字符串[]）：要删除的别名列表。支持通配符 (*)。要删除所有别名，请使用 * 或 _all。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

delete_data_lifecycle编辑

删除所选数据流的数据流生命周期。

端点文档

client.indices.deleteDataLifecycle({ name })

参数编辑

请求（对象）
- name （字符串 | 字符串[]）：要删除其数据流生命周期的数据流列表；使用 * 获取所有数据流
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符表达式是否应扩展到打开或关闭的索引（默认值：打开）
- master_timeout（可选，字符串 | -1 | 0）：指定连接到主节点的超时时间
- timeout （可选，字符串 | -1 | 0）：文档的显式时间戳

delete_data_stream编辑

删除数据流。

端点文档

client.indices.deleteDataStream({ name })

参数编辑

请求（对象）
- name （字符串 | 字符串[]）：要删除的数据流列表。支持通配符 (*) 表达式。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的数据流类型。支持值列表，例如 open,hidden。

delete_index_template编辑

删除索引模板。

端点文档

client.indices.deleteIndexTemplate({ name })

参数编辑

请求（对象）
- name （字符串 | 字符串[]）：用于限制请求的索引模板名称列表。支持通配符 (*) 表达式。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

delete_template编辑

删除索引模板。

端点文档

client.indices.deleteTemplate({ name })

参数编辑

请求（对象）
- name （字符串）：要删除的旧索引模板的名称。支持通配符 (*) 表达式。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

disk_usage编辑

分析索引或数据流中每个字段的磁盘使用情况

端点文档

client.indices.diskUsage({ index })

参数编辑

请求（对象）
- index （字符串 | 字符串[]）：用于限制请求的数据流、索引和别名列表。建议对单个索引（或数据流的最新后备索引）执行此 API，因为 API 会消耗大量资源。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺少或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则针对 foo*,bar* 的请求将返回错误。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）数组）：通配符模式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。
- flush （可选，布尔值）：如果为 true，则 API 在分析之前执行刷新。如果为 false，则响应中可能不包括未提交的数据。
- ignore_unavailable（可选，布尔值）：如果为 true，则缺失或已关闭的索引不会包含在响应中。
- run_expensive_tasks （可选，布尔值）：分析字段磁盘使用情况是一项资源密集型操作。要使用 API，必须将此参数设置为 true。

downsample编辑

对索引进行降采样

端点文档

client.indices.downsample({ index, target_index })

参数编辑

请求（对象）
- index （字符串）：要降采样的时间序列索引的名称。
- target_index （字符串）：要创建的索引的名称。
- config （可选，{ fixed_interval }）

exists编辑

返回有关特定索引是否存在的信息。

端点文档

client.indices.exists({ index })

参数编辑

请求（对象）
- index （字符串 | 字符串[]）：数据流、索引和别名列表。支持通配符 (*)。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- flat_settings （可选，布尔值）：如果为 true，则以平面格式返回设置。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- include_defaults （可选，布尔值）：如果为 true，则在响应中返回所有默认设置。
- local（可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。

exists_alias编辑

返回有关特定别名是否存在的信息。

端点文档

client.indices.existsAlias({ name })

参数编辑

请求（对象）
- name （字符串 | 字符串[]）：要检查的别名列表。支持通配符 (*)。
- index （可选，字符串 | 字符串[]）：用于限制请求的数据流或索引列表。支持通配符 (*)。要定位所有数据流和索引，请省略此参数或使用 * 或 _all。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则在目标索引或数据流中包含缺少的数据流或索引的请求将返回错误。
- local（可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。

exists_index_template编辑

返回有关特定索引模板是否存在的信息。

端点文档

client.indices.existsIndexTemplate({ name })

参数编辑

请求（对象）
- name （字符串）：用于限制请求的索引模板名称列表。支持通配符 (*) 表达式。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

exists_template编辑

返回有关特定索引模板是否存在的信息。

端点文档

client.indices.existsTemplate({ name })

参数编辑

请求（对象）
- name （字符串 | 字符串[]）：以逗号分隔的索引模板名称
- flat_settings （可选，布尔值）：以平面格式返回设置（默认值：false）
- local （可选，布尔值）：返回本地信息，不从主节点检索状态（默认值：false）
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时

explain_data_lifecycle编辑

检索有关索引当前数据流生命周期的信息，例如任何可能遇到的错误、创建时间等。

端点文档

client.indices.explainDataLifecycle({ index })

参数编辑

请求（对象）
- index （字符串 | 字符串[]）：要解释的索引的名称
- include_defaults （可选，布尔值）：指示 API 是否应返回系统用于索引生命周期的默认值
- master_timeout（可选，字符串 | -1 | 0）：指定连接到主节点的超时时间

field_usage_stats编辑

返回索引中每个字段的字段使用情况统计信息

端点文档

client.indices.fieldUsageStats({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串[]）：用于限制请求的索引名称的列表或通配符表达式。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅指向缺少或关闭的索引，则请求将返回错误。即使请求指向其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则指向 foo*,bar* 的请求将返回错误。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）数组）：通配符模式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。
- ignore_unavailable（可选，布尔值）：如果为 true，则缺失或已关闭的索引不会包含在响应中。
- fields （可选，字符串 | 字符串[]）：要包含在统计信息中的字段的列表或通配符表达式。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

flush编辑

对一个或多个索引执行刷新操作。

端点文档

client.indices.flush({ ... })

参数编辑

请求（对象）
- index （可选，字符串 | 字符串[]）：要刷新的数据流、索引和别名列表。支持通配符 (*)。要刷新所有数据流和索引，请省略此参数或使用 * 或 _all。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- force （可选，布尔值）：如果为 true，则即使没有要提交到索引的更改，请求也会强制刷新。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- wait_if_ongoing （可选，布尔值）：如果为 true，则刷新操作会在另一个刷新操作运行时阻塞，直到执行完毕。如果为 false，则如果在另一个刷新操作运行时请求刷新，Elasticsearch 将返回错误。

forcemerge编辑

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

端点文档

client.indices.forcemerge({ ... })

参数编辑

请求（对象）
- index （可选，字符串 | 字符串[]）：索引名称列表；使用 _all 或空字符串对所有索引执行操作
- allow_no_indices （可选，布尔值）：是否忽略通配符索引表达式解析为无具体索引的情况。（这包括 _all 字符串或未指定任何索引时）
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：是否将通配符表达式扩展到打开、关闭或同时打开和关闭的具体索引。
- flush （可选，布尔值）：指定在执行操作后是否应刷新索引（默认值：true）
- ignore_unavailable （可选，布尔值）：当指定的具体索引不可用（丢失或关闭）时是否应忽略它们
- max_num_segments（可选，数字）：索引应合并到的段数（默认值：动态）
- only_expunge_deletes（可选，布尔值）：指定操作是否应仅清除已删除的文档
- wait_for_completion（可选，布尔值）：请求是否应等到强制合并完成。

获取编辑

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

端点文档

client.indices.get({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串数组）：用于限制请求的数据流、索引和索引别名列表。支持通配符表达式 (*)。
- allow_no_indices（可选，boolean）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。例如，如果一个索引以 foo 开头但没有索引以 bar 开头，则针对 foo*,bar* 的请求将返回错误。
- expand_wildcards（可选，枚举（“all” | “open” | “closed” | “hidden” | “none”） | 枚举（“all” | “open” | “closed” | “hidden” | “none”）数组）：通配符表达式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open、hidden。
- flat_settings（可选，布尔值）：如果为 true，则以平面格式返回设置。
- ignore_unavailable（可选，布尔值）：如果为 false，则定位到缺少索引的请求将返回错误。
- include_defaults（可选，布尔值）：如果为 true，则在响应中返回所有默认设置。
- local （可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。默认为 false，这意味着从主节点检索信息。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- features（可选，{ name, description } | { name, description }数组）：仅返回有关指定索引特征的信息

获取别名编辑

返回别名。

端点文档

client.indices.getAlias({ ... })

参数编辑

请求（对象）
- name（可选，字符串 | 字符串数组）：要检索的别名列表。支持通配符 (*)。要检索所有别名，请省略此参数或使用 * 或 _all。
- index （可选，字符串 | 字符串[]）：用于限制请求的数据流或索引列表。支持通配符 (*)。要定位所有数据流和索引，请省略此参数或使用 * 或 _all。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- local（可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。

获取数据生命周期编辑

返回所选数据流的数据流生命周期。

端点文档

client.indices.getDataLifecycle({ name })

参数编辑

请求（对象）
- name（字符串 | 字符串数组）：用于限制请求的数据流列表。支持通配符 (*)。要定位所有数据流，请省略此参数或使用 * 或 _all。
- expand_wildcards（可选，枚举（“all” | “open” | “closed” | “hidden” | “none”） | 枚举（“all” | “open” | “closed” | “hidden” | “none”）数组）：通配符模式可以匹配的数据流类型。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- include_defaults （可选，布尔值）：如果为 true，则在响应中返回所有默认设置。

获取数据流编辑

返回数据流。

端点文档

client.indices.getDataStream({ ... })

参数编辑

请求（对象）
- name（可选，字符串 | 字符串数组）：用于限制请求的数据流名称列表。支持通配符 (*) 表达式。如果省略，则返回所有数据流。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的数据流类型。支持值列表，例如 open,hidden。
- include_defaults（可选，布尔值）：如果为 true，则返回索引模板的所有相关默认配置。

获取字段映射编辑

返回一个或多个字段的映射。

端点文档

client.indices.getFieldMapping({ fields })

参数编辑

请求（对象）
- fields（字符串 | 字符串数组）：用于限制返回信息的字段列表或通配符表达式。
- index（可选，string | string[]）：用于限制请求的数据流、索引和别名列表。支持通配符（*）。要定位所有数据流和索引，请省略此参数或使用*或_all。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- include_defaults （可选，布尔值）：如果为 true，则在响应中返回所有默认设置。
- local（可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。

获取索引模板编辑

返回索引模板。

端点文档

client.indices.getIndexTemplate({ ... })

参数编辑

请求（对象）
- name（可选，字符串）：用于限制请求的索引模板名称列表。支持通配符 (*) 表达式。
- local （可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。默认为 false，这意味着从主节点检索信息。
- flat_settings（可选，布尔值）：如果为 true，则以平面格式返回设置。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- include_defaults（可选，布尔值）：如果为 true，则返回索引模板的所有相关默认配置。

获取映射编辑

返回一个或多个索引的映射。

端点文档

client.indices.getMapping({ ... })

参数编辑

请求（对象）
- index（可选，string | string[]）：用于限制请求的数据流、索引和别名列表。支持通配符（*）。要定位所有数据流和索引，请省略此参数或使用*或_all。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- local（可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

获取设置编辑

返回一个或多个索引的设置。

端点文档

client.indices.getSettings({ ... })

参数编辑

请求（对象）
- index（可选，string | string[]）：用于限制请求的数据流、索引和别名列表。支持通配符（*）。要定位所有数据流和索引，请省略此参数或使用*或_all。
- name（可选，字符串 | 字符串数组）：要检索的设置列表或通配符表达式。
- allow_no_indices（可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅定位到缺少或关闭的索引，则请求将返回错误。即使请求定位到其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则定位到 foo*,bar* 的请求将返回错误。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）数组）：通配符模式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。
- flat_settings （可选，布尔值）：如果为 true，则以平面格式返回设置。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- include_defaults （可选，布尔值）：如果为 true，则在响应中返回所有默认设置。
- local （可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。如果为 false，则从主节点检索信息。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

获取模板编辑

返回索引模板。

端点文档

client.indices.getTemplate({ ... })

参数编辑

请求（对象）
- name（可选，字符串 | 字符串数组）：用于限制请求的索引模板名称列表。支持通配符 (*) 表达式。要返回所有索引模板，请省略此参数或使用值 _all 或 *。
- flat_settings （可选，布尔值）：如果为 true，则以平面格式返回设置。
- local（可选，布尔值）：如果为 true，则请求仅从本地节点检索信息。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

迁移到数据流编辑

将别名迁移到数据流

端点文档

client.indices.migrateToDataStream({ name })

参数编辑

请求（对象）
- name（字符串）：要转换为数据流的索引别名的名称。

修改数据流编辑

修改数据流

端点文档

client.indices.modifyDataStream({ actions })

参数编辑

请求（对象）
- actions（{ add_backing_index, remove_backing_index }数组）：要执行的操作。

打开编辑

打开索引。

端点文档

client.indices.open({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串数组）：用于限制请求的数据流、索引和别名列表。支持通配符 (*)。默认情况下，您必须显式命名用于限制请求的索引。要使用 _all、* 或其他通配符表达式来限制请求，请将 action.destructive_requires_name 设置更改为 false。您可以在 elasticsearch.yml 文件中或使用集群更新设置 API 来更新此设置。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

提升数据流编辑

将数据流从 CCR 管理的复制数据流提升为常规数据流

端点文档

client.indices.promoteDataStream({ name })

参数编辑

请求（对象）
- name（字符串）：数据流的名称

放置别名编辑

创建或更新别名。

端点文档

client.indices.putAlias({ index, name })

参数编辑

请求（对象）
- index（字符串 | 字符串数组）：要添加的数据流或索引列表。支持通配符 (*)。与数据流和索引都匹配的通配符模式将返回错误。
- name（字符串）：要更新的别名。如果别名不存在，则请求将创建它。索引别名支持日期数学运算。
- filter（可选，{ 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })：用于限制别名可以访问的文档的查询。
- index_routing（可选，字符串）：用于将索引操作路由到特定分片的值。如果指定，这将覆盖索引操作的 routing 值。数据流别名不支持此参数。
- is_write_index（可选，布尔值）：如果为 true，则设置别名的写入索引或数据流。如果别名指向多个索引或数据流并且未设置 is_write_index，则别名将拒绝写入请求。如果索引别名指向一个索引并且未设置 is_write_index，则该索引将自动充当写入索引。即使别名指向一个数据流，数据流别名也不会自动设置写入数据流。
- routing（可选，字符串）：用于将索引和搜索操作路由到特定分片的参数值。数据流别名不支持此参数。
- search_routing（可选，字符串）：用于将搜索操作路由到特定分片的参数值。如果指定，则会覆盖搜索操作的 routing 值。数据流别名不支持此参数。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

put_data_lifecycleedit

更新所选数据流的数据流生命周期。

端点文档

client.indices.putDataLifecycle({ name })

参数edit

请求（对象）
- name（字符串 | 字符串数组）：用于限制请求的数据流列表。支持通配符（*）。要定位所有数据流，请使用 * 或 _all。
- data_retention（可选，字符串 | -1 | 0）：如果定义，则添加到此数据流的每个文档将至少存储此时间范围。在此时间段后的任何时间都可以删除文档。如果为空，则此数据流中的每个文档将无限期存储。
- downsampling（可选，{ rounds }）：如果定义，则在每个支持索引不再是数据流写入索引后，将执行配置的下采样配置。
- expand_wildcards（可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）数组）：通配符模式可以匹配的数据流类型。支持值列表，例如 open,hidden。有效值为：all、hidden、open、closed、none。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

put_index_templateedit

创建或更新索引模板。

端点文档

client.indices.putIndexTemplate({ name })

参数edit

请求（对象）
- name（字符串）：索引或模板名称
- index_patterns（可选，字符串 | 字符串数组）：要创建的索引模板的名称。
- composed_of（可选，字符串数组）：组件模板名称的有序列表。组件模板按指定的顺序合并，这意味着指定的最后一个组件模板具有最高优先级。
- template（可选，{ aliases, mappings, settings, lifecycle }）：要应用的模板。它可以选择包含 aliases、mappings 或 settings 配置。
- data_stream（可选，{ hidden }）：如果包含此对象，则该模板用于创建数据流及其支持索引。支持空对象。数据流需要匹配的索引模板，其中包含 data_stream 对象。
- priority（可选，数字）：用于确定在创建新的数据流或索引时索引模板优先级的优先级。选择优先级最高的索引模板。如果未指定优先级，则将模板视为优先级为 0（最低优先级）。此数字不是由 Elasticsearch 自动生成的。
- version（可选，数字）：用于在外部管理索引模板的版本号。此数字不是由 Elasticsearch 自动生成的。
- _meta（可选，记录<字符串，用户定义的值>）：关于索引模板的可选用户元数据。可以有任何内容。此映射不是由 Elasticsearch 自动生成的。
- allow_auto_create（可选，布尔值）：此设置会覆盖 action.auto_create_index 集群设置的值。如果在模板中设置为 true，则即使通过 actions.auto_create_index 禁用了索引的自动创建，也可以使用该模板自动创建索引。如果设置为 false，则始终必须显式创建与模板匹配的索引或数据流，并且可能永远不会自动创建。
- ignore_missing_component_templates（可选，字符串数组）：当索引模板引用可能不存在的组件模板时，可以使用配置选项 ignore_missing_component_templates
- deprecated （可选，布尔值）：将此索引模板标记为已弃用。创建或更新使用已弃用组件的未弃用索引模板时，Elasticsearch 将发出弃用警告。
- create（可选，布尔值）：如果为 true，则此请求不能替换或更新现有的索引模板。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- cause（可选，字符串）：用户定义的创建/更新索引模板的原因

put_mappingedit

更新索引映射。

端点文档

client.indices.putMapping({ index })

参数edit

请求（对象）
- index（字符串 | 字符串数组）：应添加映射的索引名称列表（支持通配符）；使用 _all 或省略在所有索引上添加映射。
- date_detection（可选，布尔值）：控制是否启用动态日期检测。
- dynamic（可选，枚举（"strict" | "runtime" | true | false））：控制是否动态添加新字段。
- dynamic_date_formats（可选，字符串数组）：如果启用了日期检测，则会根据 dynamic_date_formats 检查新的字符串字段，如果值匹配，则会添加新的日期字段而不是字符串。
- dynamic_templates（可选，记录<字符串，{ mapping, runtime, match, path_match, unmatch, path_unmatch, match_mapping_type, unmatch_mapping_type, match_pattern }> | 记录<字符串，{ mapping, runtime, match, path_match, unmatch, path_unmatch, match_mapping_type, unmatch_mapping_type, match_pattern }>数组）：为映射指定动态模板。
- _field_names（可选，{ enabled }）：控制是否为索引启用字段名称。
- _meta（可选，记录<字符串，用户定义的值>）：映射类型可以具有与其关联的自定义元数据。Elasticsearch 根本不使用这些元数据，但可以用来存储应用程序特定的元数据。
- numeric_detection（可选，布尔值）：自动将所有字段的字符串映射为数值数据类型。
- properties（可选，记录<字符串，{ type } | { boost, fielddata, index, null_value, type } | { type, enabled, null_value, boost, coerce, script, on_script_error, ignore_malformed, time_series_metric, analyzer, eager_global_ordinals, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, format, precision_step, locale } | { relations, eager_global_ordinals, type } | { boost, eager_global_ordinals, index, index_options, script, on_script_error, normalizer, norms, null_value, split_queries_on_whitespace, time_series_dimension, type } | { type, fields, meta, copy_to } | { type } | { positive_score_impact, type } | { positive_score_impact, type } | { analyzer, index, index_options, max_shingle_size, norms, search_analyzer, search_quote_analyzer, term_vector, type } | { analyzer, boost, eager_global_ordinals, fielddata, fielddata_frequency_filter, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, type } | { type } | { type, null_value } | { boost, format, ignore_malformed, index, null_value, precision_step, type } | { boost, fielddata, format, ignore_malformed, index, null_value, precision_step, locale, type } | { type, default_metric, metrics, time_series_metric } | { type, element_type, dims, similarity, index, index_options } | { type } | { boost, depth_limit, doc_values, eager_global_ordinals, index, index_options, null_value, similarity, split_queries_on_whitespace, type } | { enabled, include_in_parent, include_in_root, type } | { enabled, subobjects, type } | { analyzer, contexts, max_input_length, preserve_position_increments, preserve_separators, search_analyzer, type } | { value, type } | { path, type } | { ignore_malformed, type } | { boost, index, ignore_malformed, null_value, on_script_error, script, time_series_dimension, type } | { type } | { analyzer, boost, index, null_value, enable_position_increments, type } | { ignore_malformed, ignore_z_value, null_value, index, on_script_error, script, type } | { coerce, ignore_malformed, ignore_z_value, orientation, strategy, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, type } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value, scaling_factor } | { type, null_value } | { type, null_value } | { format, type } | { type } | { type } | { type } | { type } | { type } | { type, norms, index_options, index, null_value, rules, language, country, variant, strength, decomposition, alternate, case_level, case_first, numeric, variable_top, hiragana_quaternary_mode }>）：字段的映射。对于新字段，此映射可以包含
  - 字段名称
  - 字段数据类型
  - 映射参数
- _routing（可选，{ required }）：启用对索引文档所需的路由值。
- _source（可选，{ compress, compress_threshold, enabled, excludes, includes, mode }）：控制是否在索引上启用 _source 字段。
- runtime（可选，记录<字符串，{ fetch_fields, format, input_field, target_field, target_index, script, type }>）：索引的运行时字段映射。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- write_index_only（可选，布尔值）：如果为 true，则映射仅应用于目标的当前写入索引。

put_settingsedit

更新索引设置。

端点文档

client.indices.putSettings({ ... })

参数edit

请求（对象）
- index（可选，string | string[]）：用于限制请求的数据流、索引和别名列表。支持通配符（*）。要定位所有数据流和索引，请省略此参数或使用*或_all。
- settings（可选，{ index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store }）
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅指向缺少或关闭的索引，则请求将返回错误。即使请求指向其他打开的索引，此行为也适用。例如，如果索引以 foo 开头但没有索引以 bar 开头，则指向 foo*,bar* 的请求将返回错误。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）数组）：通配符模式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。
- flat_settings （可选，布尔值）：如果为 true，则以平面格式返回设置。
- ignore_unavailable（可选，布尔值）：如果为 true，则以平面格式返回设置。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- preserve_existing（可选，布尔值）：如果为 true，则现有索引设置保持不变。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

put_templateedit

创建或更新索引模板。

端点文档

client.indices.putTemplate({ name })

参数编辑

请求（对象）
- name（字符串）：模板的名称
- aliases（可选，记录<字符串，{ filter，index_routing，is_hidden，is_write_index，routing，search_routing }>）：索引的别名。
- index_patterns（可选，字符串 | 字符串数组）：用于在创建过程中匹配索引名称的通配符表达式数组。
- mappings（可选，{ all_field, date_detection, dynamic, dynamic_date_formats, dynamic_templates, _field_names, index_field, _meta, numeric_detection, properties, _routing, _size, _source, runtime, enabled, subobjects, _data_stream_timestamp }）：索引中字段的映射。
- order（可选，数字）：如果索引匹配多个模板，则 Elasticsearch 应用此模板的顺序。

order 值较低的模板先合并。order 值较高的模板后合并，覆盖值较低的模板。 settings（可选，{ index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store }）：索引的配置选项。 version（可选，数字）：用于在外部管理索引模板的版本号。此编号不是由 Elasticsearch 自动生成的。 create（可选，布尔值）：如果为 true，则此请求不能替换或更新现有的索引模板。 master_timeout（可选，字符串 | -1 | 0）：等待连接到主节点的时间段。如果在超时到期之前没有收到响应，则请求失败并返回错误。 * *cause（可选，字符串）

恢复编辑

返回有关正在进行的索引分片恢复的信息。

端点文档

client.indices.recovery({ ... })

参数编辑

请求（对象）
- index（可选，string | string[]）：用于限制请求的数据流、索引和别名列表。支持通配符（*）。要定位所有数据流和索引，请省略此参数或使用*或_all。
- active_only（可选，布尔值）：如果为 true，则响应仅包含正在进行的分片恢复。
- detailed（可选，布尔值）：如果为 true，则响应包含有关分片恢复的详细信息。

刷新编辑

在一个或多个索引中执行刷新操作。

端点文档

client.indices.refresh({ ... })

参数编辑

请求（对象）
- index（可选，string | string[]）：用于限制请求的数据流、索引和别名列表。支持通配符（*）。要定位所有数据流和索引，请省略此参数或使用*或_all。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。

重新加载搜索分析器编辑

重新加载索引的搜索分析器及其资源。

端点文档

client.indices.reloadSearchAnalyzers({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串数组）：要为其重新加载分析器的索引名称列表
- allow_no_indices （可选，布尔值）：是否忽略通配符索引表达式解析为无具体索引的情况。（这包括 _all 字符串或未指定任何索引时）
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：是否将通配符表达式扩展到打开、关闭或同时打开和关闭的具体索引。
- ignore_unavailable （可选，布尔值）：当指定的具体索引不可用（丢失或关闭）时是否应忽略它们

解析集群编辑

解析指定的索引表达式以返回有关每个集群的信息，如果包括本地集群，则包括本地集群。

端点文档

client.indices.resolveCluster({ name })

参数编辑

请求（对象）
- name（字符串 | 字符串数组）：要解析的索引、别名和数据流的逗号分隔名称或索引模式。可以使用 <cluster>:<name> 语法指定远程集群上的资源。
- allow_no_indices（可选，boolean）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。例如，如果一个索引以 foo 开头但没有索引以 bar 开头，则针对 foo*,bar* 的请求将返回错误。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_throttled（可选，布尔值）：如果为 true，则在冻结时忽略具体的、已扩展的或已设置别名的索引。默认为 false。
- ignore_unavailable（可选，布尔值）：如果为 false，则如果请求的目标是缺少的或已关闭的索引，则该请求返回错误。默认为 false。

解析索引编辑

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

端点文档

client.indices.resolveIndex({ name })

参数编辑

请求（对象）
- name（字符串 | 字符串数组）：要解析的索引、别名和数据流的逗号分隔名称或索引模式。可以使用 <cluster>:<name> 语法指定远程集群上的资源。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。

滚动更新编辑

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

端点文档

client.indices.rollover({ alias })

参数编辑

请求（对象）
- alias（字符串）：要滚动更新的数据流或索引别名的名称。
- new_index（可选，字符串）：要创建的索引的名称。支持日期数学。数据流不支持此参数。
- aliases（可选，记录<字符串，{ filter, index_routing, is_hidden, is_write_index, routing, search_routing }>）：目标索引的别名。数据流不支持此参数。
- conditions（可选，{ min_age, max_age, max_age_millis, min_docs, max_docs, max_size, max_size_bytes, min_size, min_size_bytes, max_primary_shard_size, max_primary_shard_size_bytes, min_primary_shard_size, min_primary_shard_size_bytes, max_primary_shard_docs, min_primary_shard_docs }）：滚动更新的条件。如果指定，则 Elasticsearch 仅在当前索引满足这些条件时才执行滚动更新。如果未指定此参数，则 Elasticsearch 无条件地执行滚动更新。如果指定了条件，则其中至少有一个必须是 max_* 条件。如果满足任何 max_* 条件并且满足所有 min_* 条件，则索引将滚动更新。
- mappings（可选，{ all_field, date_detection, dynamic, dynamic_date_formats, dynamic_templates, _field_names, index_field, _meta, numeric_detection, properties, _routing, _size, _source, runtime, enabled, subobjects, _data_stream_timestamp }）：索引中字段的映射。如果指定，则此映射可以包括字段名称、字段数据类型和映射参数。
- settings（可选，记录<字符串，用户定义的值>）：索引的配置选项。数据流不支持此参数。
- dry_run（可选，布尔值）：如果为 true，则检查当前索引是否满足指定的条件，但不执行滚动更新。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

段编辑

提供有关 Lucene 索引中段的低级信息。

端点文档

client.indices.segments({ ... })

参数编辑

请求（对象）
- index（可选，string | string[]）：用于限制请求的数据流、索引和别名列表。支持通配符（*）。要定位所有数据流和索引，请省略此参数或使用*或_all。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- verbose（可选，布尔值）：如果为 true，则请求返回详细响应。

分片存储编辑

提供索引的分片副本的存储信息。

端点文档

client.indices.shardStores({ ... })

参数编辑

请求（对象）
- index（可选，字符串 | 字符串数组）：用于限制请求的数据流、索引和别名列表。
- allow_no_indices（可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺少的或已关闭的索引，则请求返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards（可选，枚举（“all” | “open” | “closed” | “hidden” | “none”）| 枚举（“all” | “open” | “closed” | “hidden” | “none”）[]）：通配符模式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏的数据流。
- ignore_unavailable（可选，boolean）：如果为 true，则响应中不包括缺失或关闭的索引。
- status（可选，枚举（“green” | “yellow” | “red” | “all”）| 枚举（“green” | “yellow” | “red” | “all”）[]）：用于限制请求的分片运行状况状态列表。

收缩编辑

允许将现有索引收缩到主分片较少的新索引中。

端点文档

client.indices.shrink({ index, target })

参数编辑

请求（对象）
- index（字符串）：要收缩的源索引的名称。
- target（字符串）：要创建的目标索引的名称。
- aliases（可选，记录<字符串，{ filter, index_routing, is_hidden, is_write_index, routing, search_routing }>）：键是别名。索引别名支持日期数学。
- settings（可选，记录<字符串，用户定义的值>）：目标索引的配置选项。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

模拟索引模板编辑

模拟将给定的索引名称与系统中的索引模板进行匹配

端点文档

client.indices.simulateIndexTemplate({ name })

参数编辑

请求（对象）
- name（字符串）：要模拟的索引的名称
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- include_defaults（可选，布尔值）：如果为 true，则返回索引模板的所有相关默认配置。

模拟模板编辑

模拟解析给定的模板名称或正文

端点文档

client.indices.simulateTemplate({ ... })

参数编辑

请求（对象）
- name（可选，字符串）：要模拟的索引模板的名称。要在将模板配置添加到集群之前对其进行测试，请省略此参数并在请求正文中指定模板配置。
- allow_auto_create（可选，布尔值）：此设置会覆盖 action.auto_create_index 集群设置的值。如果在模板中设置为 true，则即使通过 actions.auto_create_index 禁用了索引的自动创建，也可以使用该模板自动创建索引。如果设置为 false，则始终必须显式创建与模板匹配的索引或数据流，并且可能永远不会自动创建。
- index_patterns（可选，字符串 | 字符串数组）：通配符 (*) 表达式数组，用于在创建期间匹配数据流和索引的名称。
- composed_of（可选，字符串数组）：组件模板名称的有序列表。组件模板按指定的顺序合并，这意味着指定的最后一个组件模板具有最高优先级。
- template（可选，{ aliases, mappings, settings, lifecycle }）：要应用的模板。它可以选择包含 aliases、mappings 或 settings 配置。
- data_stream（可选，{ hidden }）：如果包含此对象，则该模板用于创建数据流及其支持索引。支持空对象。数据流需要匹配的索引模板，其中包含 data_stream 对象。
- priority（可选，数字）：用于确定在创建新的数据流或索引时索引模板优先级的优先级。选择优先级最高的索引模板。如果未指定优先级，则将模板视为优先级为 0（最低优先级）。此数字不是由 Elasticsearch 自动生成的。
- version（可选，数字）：用于在外部管理索引模板的版本号。此数字不是由 Elasticsearch 自动生成的。
- _meta（可选，记录<字符串，用户定义的值>）：关于索引模板的可选用户元数据。可以有任何内容。此映射不是由 Elasticsearch 自动生成的。
- ignore_missing_component_templates（可选，字符串数组）：当索引模板引用可能不存在的组件模板时，可以使用配置选项 ignore_missing_component_templates
- deprecated （可选，布尔值）：将此索引模板标记为已弃用。创建或更新使用已弃用组件的未弃用索引模板时，Elasticsearch 将发出弃用警告。
- create（可选，布尔值）：如果为 true，则仅当没有现有模板与相同的索引模式匹配时，才会使用正文中传递的模板。如果为 false，则模拟将使用优先级最高的模板。请注意，在这两种情况下，模板都不会被永久添加或更新；它仅用于模拟。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- include_defaults（可选，布尔值）：如果为 true，则返回索引模板的所有相关默认配置。

拆分编辑

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

端点文档

client.indices.split({ index, target })

参数编辑

请求（对象）
- index（字符串）：要拆分的源索引的名称。
- target（字符串）：要创建的目标索引的名称。
- aliases（可选，记录<字符串，{ filter，index_routing，is_hidden，is_write_index，routing，search_routing }>）：结果索引的别名。
- settings（可选，记录<字符串，用户定义的值>）：目标索引的配置选项。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_active_shards （可选，数字 | 枚举（"all" | "index-setting"））：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

统计编辑

提供索引中发生的运营统计信息。

端点文档

client.indices.stats({ ... })

参数编辑

请求（对象）
- metric（可选，字符串 | 字符串数组）：限制返回到特定指标的信息。
- index （可选，字符串 | 字符串[]）：索引名称列表；使用 _all 或空字符串对所有索引执行操作
- completion_fields（可选，字符串 | 字符串数组）：要包含在字段数据和建议统计信息中的字段的列表或通配符表达式。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）数组）：通配符模式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。
- fielddata_fields（可选，字符串 | 字符串数组）：要包含在字段数据统计信息中的字段的列表或通配符表达式。
- fields （可选，字符串 | 字符串[]）：要包含在统计信息中的字段的列表或通配符表达式。
- forbid_closed_indices（可选，布尔值）：如果为 true，则不会从关闭的索引中收集统计信息。
- groups（可选，字符串 | 字符串数组）：要包含在搜索统计信息中的搜索组列表。
- include_segment_file_sizes（可选，布尔值）：如果为 true，则调用将报告每个 Lucene 索引文件的聚合磁盘使用情况（仅在请求段统计信息时适用）。
- include_unloaded_segments（可选，布尔值）：如果为 true，则响应包括未加载到内存中的段的信息。
- level（可选，枚举（"cluster" | "indices" | "shards"））：指示是在集群、索引还是分片级别聚合统计信息。

解冻编辑

解冻索引。当冻结的索引解冻时，该索引将经历正常的恢复过程，并再次变为可写状态。

端点文档

client.indices.unfreeze({ index })

参数编辑

请求（对象）
- index（字符串）：索引的标识符。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_active_shards（可选，字符串）：在继续操作之前必须处于活动状态的分片副本数。设置为 all 或任何正整数，最大值为索引中的分片总数 (number_of_replicas+1)。

更新别名编辑

更新索引别名。

端点文档

client.indices.updateAliases({ ... })

参数编辑

请求（对象）
- actions（可选，{ add_backing_index, remove_backing_index }[]）：要执行的操作。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

验证查询编辑

允许用户验证可能很昂贵的查询，而无需执行它。

端点文档

client.indices.validateQuery({ ... })

参数编辑

请求（对象）
- index（可选，字符串 | 字符串数组）：要搜索的数据流、索引和别名列表。支持通配符 (*)。要搜索所有数据流或索引，请省略此参数或使用 * 或 _all。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：使用 Lucene 查询字符串语法的查询。
- allow_no_indices （可选，布尔值）：如果为 false，则如果任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引，则请求将返回错误。即使请求针对其他打开的索引，此行为也适用。
- all_shards（可选，布尔值）：如果为 true，则验证将在所有分片上执行，而不是在每个索引的一个随机分片上执行。
- analyzer （可选，字符串）：用于查询字符串的分析器。此参数只能在指定了 q 查询字符串参数时使用。
- analyze_wildcard （可选，布尔值）：如果为 true，则分析通配符和前缀查询。
- default_operator （可选，枚举（"and" | "or"））：查询字符串查询的默认运算符：AND 或 OR。
- df （可选，字符串）：在查询字符串中未给出字段前缀时用作默认值的字段。此参数只能在指定了 q 查询字符串参数时使用。
- expand_wildcards （可选，枚举（"all" | "open" | "closed" | "hidden" | "none"） | 枚举（"all" | "open" | "closed" | "hidden" | "none"）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表，例如 open,hidden。有效值为：all、open、closed、hidden、none。
- explain（可选，布尔值）：如果为 true，则如果发生错误，响应将返回详细信息。
- ignore_unavailable （可选，布尔值）：如果为 false，则如果请求针对缺失或关闭的索引，则该请求将返回错误。
- lenient （可选，布尔值）：如果为 true，则将忽略查询字符串中基于格式的查询失败（例如，向数字字段提供文本）。
- rewrite（可选，布尔值）：如果为 true，则返回更详细的说明，显示将要执行的实际 Lucene 查询。
- q （可选，字符串）：使用 Lucene 查询字符串语法的查询。

推理编辑

删除模型编辑

在推理 API 中删除模型

端点文档

client.inference.deleteModel({ inference_id })

参数编辑

请求（对象）
- inference_id（字符串）：推理 ID
- task_type（可选，枚举（"sparse_embedding" | "text_embedding" | "rerank" | "completion"））：任务类型

获取模型编辑

在推理 API 中获取模型

端点文档

client.inference.getModel({ inference_id })

参数编辑

请求（对象）
- inference_id（字符串）：推理 ID
- task_type（可选，枚举（"sparse_embedding" | "text_embedding" | "rerank" | "completion"））：任务类型

推理编辑

对模型执行推理

端点文档

client.inference.inference({ inference_id, input })

参数编辑

请求（对象）
- inference_id（字符串）：推理 ID
- input（字符串 | 字符串数组）：模型的文本输入。可以是字符串或字符串数组。
- task_type（可选，枚举（"sparse_embedding" | "text_embedding" | "rerank" | "completion"））：任务类型
- query（可选，字符串）：查询输入，rerank 任务需要。其他任务不需要。
- task_settings（可选，用户定义的值）：可选的任务设置
- timeout（可选，字符串 | -1 | 0）：指定等待推理请求完成的时间。

放置模型编辑

配置模型以在推理 API 中使用

端点文档

client.inference.putModel({ inference_id })

参数编辑

请求（对象）
- inference_id（字符串）：推理 ID
- task_type（可选，枚举（"sparse_embedding" | "text_embedding" | "rerank" | "completion"））：任务类型
- model_config（可选，{ service, service_settings, task_settings }）

摄取编辑

删除管道编辑

删除管道。

端点文档

client.ingest.deletePipeline({ id })

参数编辑

请求（对象）
- id（字符串）：用于限制请求的管道 ID 或管道 ID 的通配符表达式。要删除集群中的所有摄取管道，请使用值 *。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

geoip 统计编辑

返回有关 geoip 数据库的统计信息

端点文档

client.ingest.geoIpStats()

获取管道编辑

返回管道。

端点文档

client.ingest.getPipeline({ ... })

参数编辑

请求（对象）
- id（可选，字符串）：要检索的管道 ID 列表。支持通配符 (*) 表达式。要获取所有摄取管道，请省略此参数或使用 *。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- summary（可选，布尔值）：返回没有定义的管道（默认值：false）

处理器 grok编辑

返回内置模式列表。

端点文档

client.ingest.processorGrok()

放置管道编辑

创建或更新管道。

端点文档

client.ingest.putPipeline({ id })

参数编辑

请求（对象）
- id（字符串）：要创建或更新的摄取管道的 ID。
- _meta（可选，记录<字符串，用户定义的值>）：有关摄取管道的可选元数据。可以有任何内容。此映射不是由 Elasticsearch 自动生成的。
- description（可选，字符串）：摄取管道的描述。
- on_failure（可选，{ attachment, append, csv, convert, date, date_index_name, dot_expander, enrich, fail, foreach, json, user_agent, kv, geoip, grok, gsub, join, lowercase, remove, rename, reroute, script, set, sort, split, trim, uppercase, urldecode, bytes, dissect, set_security_user, pipeline, drop, circle, inference }[]）：处理器在处理器失败后立即运行。每个处理器都支持处理器级别的 on_failure 值。如果没有 on_failure 值的处理器失败，Elasticsearch 将使用此管道级别的参数作为回退。此参数中的处理器按指定的顺序依次运行。Elasticsearch 将不会尝试运行管道的其余处理器。
- processors（可选，{ attachment、append、csv、convert、date、date_index_name、dot_expander、enrich、fail、foreach、json、user_agent、kv、geoip、grok、gsub、join、lowercase、remove、rename、reroute、script、set、sort、split、trim、uppercase、urldecode、bytes、dissect、set_security_user、pipeline、drop、circle、inference }[]）：用于在索引之前对文档执行转换的处理器。处理器按指定的顺序依次运行。
- version（可选，数字）：外部系统用于跟踪摄取管道的版本号。此参数仅供外部系统使用。Elasticsearch 不使用或验证管道版本号。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- if_version（可选，数字）：乐观并发控制管道更新所需的版本

simulate编辑

允许使用示例文档模拟管道。

端点文档

client.ingest.simulate({ ... })

参数编辑

请求（对象）
- id（可选，字符串）：要测试的管道。如果未在请求正文中指定 pipeline，则此参数是必需的。
- docs（可选，{ _id、_index、_source }[]）：要在管道中测试的示例文档。
- pipeline（可选，{ description、on_failure、processors、version、_meta }）：要测试的管道。如果未指定 pipeline 请求路径参数，则此参数是必需的。如果同时指定此参数和请求路径参数，则 API 仅使用请求路径参数。
- verbose（可选，布尔值）：如果为 true，则响应中包含已执行管道中每个处理器的输出数据。

license编辑

delete编辑

删除集群的许可证信息

端点文档

client.license.delete()

get编辑

检索集群的许可证信息

端点文档

client.license.get({ ... })

参数编辑

请求（对象）
- accept_enterprise（可选，布尔值）：如果为 true，则此参数为企业版许可证类型返回 enterprise。如果为 false，则此参数为白金版和企业版许可证类型返回 platinum。保留此行为是为了向后兼容。此参数已弃用，在 8.x 中将始终设置为 true。
- local（可选，布尔值）：指定是否检索本地信息。默认值为 false，这意味着信息是从主节点检索的。

get_basic_status编辑

检索有关基本许可证状态的信息。

端点文档

client.license.getBasicStatus()

get_trial_status编辑

检索有关试用许可证状态的信息。

端点文档

client.license.getTrialStatus()

post编辑

更新集群的许可证。

端点文档

client.license.post({ ... })

参数编辑

请求（对象）
- license（可选，{ expiry_date_in_millis、issue_date_in_millis、start_date_in_millis、issued_to、issuer、max_nodes、max_resource_units、signature、type、uid }）
- licenses（可选，{ expiry_date_in_millis、issue_date_in_millis、start_date_in_millis、issued_to、issuer、max_nodes、max_resource_units、signature、type、uid }[]）：一个或多个包含许可证信息的 JSON 文档序列。
- acknowledge（可选，布尔值）：指定是否确认许可证更改。

post_start_basic编辑

启动无限期基本许可证。

端点文档

client.license.postStartBasic({ ... })

参数编辑

请求（对象）
- acknowledge（可选，布尔值）：用户是否已确认确认消息（默认值：false）

post_start_trial编辑

启动限时试用许可证。

端点文档

client.license.postStartTrial({ ... })

参数编辑

请求（对象）
- acknowledge（可选，布尔值）：用户是否已确认确认消息（默认值：false）
- type_query_string（可选，字符串）

logstash编辑

delete_pipeline编辑

删除中央管理使用的 Logstash 管道

端点文档

client.logstash.deletePipeline({ id })

参数编辑

请求（对象）
- id（字符串）：管道的标识符。

get_pipeline编辑

检索中央管理使用的 Logstash 管道

端点文档

client.logstash.getPipeline({ ... })

参数编辑

请求（对象）
- id（可选，字符串 | 字符串[]）：管道标识符列表。

put_pipeline编辑

添加和更新用于中央管理的 Logstash 管道

端点文档

client.logstash.putPipeline({ id })

参数编辑

请求（对象）
- id（字符串）：管道的标识符。
- pipeline（可选，{ description、on_failure、processors、version、_meta }）

migration编辑

deprecations编辑

检索有关使用已弃用功能的不同集群、节点和索引级别设置的信息，这些功能将在下一个主要版本中删除或更改。

端点文档

client.migration.deprecations({ ... })

参数编辑

请求（对象）
- index（可选，字符串）：要检查的数据流或索引的逗号分隔列表。支持通配符 (*) 表达式。

get_feature_upgrade_status编辑

确定系统功能是否需要升级

端点文档

client.migration.getFeatureUpgradeStatus()

post_feature_upgrade编辑

开始升级系统功能

端点文档

client.migration.postFeatureUpgrade()

ml编辑

clear_trained_model_deployment_cache编辑

清除训练模型部署中的缓存结果

端点文档

client.ml.clearTrainedModelDeploymentCache({ model_id })

参数编辑

请求（对象）
- model_id（字符串）：训练模型的唯一标识符。

close_job编辑

关闭一个或多个异常检测作业。一个作业在其生命周期中可以多次打开和关闭。

端点文档

client.ml.closeJob({ job_id })

参数编辑

请求（对象）
- job_id（字符串）：异常检测作业的标识符。它可以是作业标识符、组名称或通配符表达式。可以通过使用组名称、作业列表或通配符表达式在单个 API 请求中关闭多个异常检测作业。可以通过使用 _all 或将 * 指定为作业标识符来关闭所有作业。
- allow_no_match（可选，布尔值）：请参阅 allow_no_match 查询参数的说明。
- force（可选，布尔值）：请参阅 force 查询参数的说明。
- timeout（可选，字符串 | -1 | 0）：请参阅 timeout 查询参数的说明。

delete_calendar编辑

删除日历。

端点文档

client.ml.deleteCalendar({ calendar_id })

参数编辑

请求（对象）
- calendar_id（字符串）：唯一标识日历的字符串。

delete_calendar_event编辑

从日历中删除计划事件。

端点文档

client.ml.deleteCalendarEvent({ calendar_id, event_id })

参数编辑

请求（对象）
- calendar_id（字符串）：唯一标识日历的字符串。
- event_id（字符串）：计划事件的标识符。可以通过使用 get calendar events API 获取此标识符。

delete_calendar_job编辑

从日历中删除异常检测作业。

端点文档

client.ml.deleteCalendarJob({ calendar_id, job_id })

参数编辑

请求（对象）
- calendar_id（字符串）：唯一标识日历的字符串。
- job_id（字符串 | 字符串[]）：异常检测作业的标识符。它可以是作业标识符、组名称或作业或组的列表。

delete_data_frame_analytics编辑

删除现有的数据帧分析作业。

端点文档

client.ml.deleteDataFrameAnalytics({ id })

参数编辑

请求（对象）
- id（字符串）：数据帧分析作业的标识符。
- force （可选，布尔值）：如果为 true，则删除未停止的作业；此方法比停止作业后再删除更快。
- timeout （可选，字符串 | -1 | 0）：等待作业删除的时间。

delete_datafeed编辑

删除现有数据馈送。

端点文档

client.ml.deleteDatafeed({ datafeed_id })

参数编辑

请求（对象）
- datafeed_id （字符串）：唯一标识数据馈送的数字字符串。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
- force （可选，布尔值）：用于强制删除已启动的数据馈送；此方法比停止数据馈送后再删除更快。

delete_expired_data编辑

删除过期的和未使用的机器学习数据。

端点文档

client.ml.deleteExpiredData({ ... })

参数编辑

请求（对象）
- job_id （可选，字符串）：异常检测作业的标识符。它可以是作业标识符、组名称或通配符表达式。
- requests_per_second （可选，浮点数）：删除进程所需的每秒请求数。默认行为是不进行限制。
- timeout （可选，字符串 | -1 | 0）：基础删除进程可以运行多长时间才会被取消。

delete_filter编辑

删除过滤器。

端点文档

client.ml.deleteFilter({ filter_id })

参数编辑

请求（对象）
- filter_id （字符串）：唯一标识过滤器的字符串。

delete_forecast编辑

从机器学习作业中删除预测。

端点文档

client.ml.deleteForecast({ job_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- forecast_id （可选，字符串）：预测标识符列表。如果未指定此可选参数，或者指定了 _all 或 *，则 API 将删除作业中的所有预测。
- allow_no_forecasts （可选，布尔值）：指定当没有预测时是否出现错误。特别是，如果此参数设置为 false 并且作业没有关联的预测，则尝试删除所有预测将返回错误。
- timeout （可选，字符串 | -1 | 0）：指定等待删除操作完成的时间段。当此时间段过去后，API 将失败并返回错误。

delete_job编辑

删除现有的异常检测作业。

端点文档

client.ml.deleteJob({ job_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- force （可选，布尔值）：用于强制删除已打开的作业；此方法比关闭作业后再删除更快。
- delete_user_annotations （可选，布尔值）：指定在重置作业时，是否应删除用户添加的注释以及任何自动生成的注释。
- wait_for_completion （可选，布尔值）：指定请求是应立即返回还是等待作业删除完成。

delete_model_snapshot编辑

删除现有的模型快照。

端点文档

client.ml.deleteModelSnapshot({ job_id, snapshot_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- snapshot_id （字符串）：模型快照的标识符。

delete_trained_model编辑

删除当前未被摄取管道引用的现有训练推理模型。

端点文档

client.ml.deleteTrainedModel({ model_id })

参数编辑

请求（对象）
- model_id（字符串）：训练模型的唯一标识符。
- force （可选，布尔值）：强制删除被摄取管道引用或已启动部署的训练模型。

delete_trained_model_alias编辑

删除引用训练模型的模型别名

端点文档

client.ml.deleteTrainedModelAlias({ model_alias, model_id })

参数编辑

请求（对象）
- model_alias （字符串）：要删除的模型别名。
- model_id （字符串）：模型别名引用的训练模型 ID。

estimate_model_memory编辑

估计模型内存

端点文档

client.ml.estimateModelMemory({ ... })

参数编辑

请求（对象）
- analysis_config （可选，{ bucket_span, categorization_analyzer, categorization_field_name, categorization_filters, detectors, influencers, latency, model_prune_window, multivariate_by_fields, per_partition_categorization, summary_count_field_name }）：有关可在该 API 正文 analysis_config 组件中指定的属性列表。
- max_bucket_cardinality （可选，Record<字符串，数字>）：在作业分析数据的整个时间段内，对影响因素字段观察到的单个桶中最高基数的估计值。为了产生良好的答案，必须为所有影响因素字段提供值。为未列为 influencers 的字段提供值不会影响估计。
- overall_cardinality （可选，Record<字符串，数字>）：在作业分析数据的整个时间段内，对字段观察到的基数的估计值。为了产生良好的答案，必须为任何检测器的 by_field_name、over_field_name 和 partition_field_name 中引用的字段提供值。为其他字段提供值不会影响估计。如果没有任何检测器具有 by_field_name、over_field_name 或 partition_field_name，则可以从请求中省略它。

evaluate_data_frame编辑

评估带注释索引的数据帧分析。

端点文档

client.ml.evaluateDataFrame({ evaluation, index })

参数编辑

请求（对象）
- evaluation （{ classification, outlier_detection, regression }）：定义要执行的评估类型。
- index （字符串）：定义将在其中执行评估的 index。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：从源索引中检索数据子集的查询子句。

explain_data_frame_analytics编辑

解释数据帧分析配置。

端点文档

client.ml.explainDataFrameAnalytics({ ... })

参数编辑

请求（对象）
- id （可选，字符串）：数据帧分析作业的标识符。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
- source （可选，{ index, query, runtime_mappings, _source }）：有关如何获取分析数据的配置。它需要一个索引。可以选择指定 query 和 _source。
- dest （可选，{ index, results_field }）：目标配置，包含 index 和可选的 results_field（默认为 ml）。
- analysis （可选，{ classification, outlier_detection, regression }）：分析配置，包含执行以下分析类型之一所需的信息：分类、异常值检测或回归。
- description （可选，字符串）：作业的描述。
- model_memory_limit （可选，字符串）：允许用于分析处理的最大内存资源（近似值）。如果 elasticsearch.yml 文件包含 xpack.ml.max_model_memory_limit 设置，则在尝试创建 model_memory_limit 值大于该设置的数据帧分析作业时会发生错误。
- max_num_threads（可选，数字）：分析中使用的最大线程数。使用更多线程可能会减少完成分析所需的时间，但会占用更多 CPU 资源。请注意，除了分析本身之外，该过程可能还会使用额外的线程来执行操作功能。
- analyzed_fields（可选，{ includes, excludes }）：指定 includes 和/或 excludes 模式以选择要包含在分析中的字段。 excludes 中指定的模式最后应用，因此 excludes 优先。换句话说，如果在 includes 和 excludes 中指定了相同的字段，则该字段将不会包含在分析中。
- allow_lazy_start（可选，布尔值）：指定当没有足够的机器学习节点容量立即将此作业分配给节点时，此作业是否可以启动。

flush_job编辑

强制处理作业中所有已缓冲的数据。

端点文档

client.ml.flushJob({ job_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- advance_time（可选，字符串 | 单位）：请参阅 advance_time 查询参数的说明。
- calc_interim（可选，布尔值）：请参阅 calc_interim 查询参数的说明。
- end（可选，字符串 | 单位）：请参阅 end 查询参数的说明。
- skip_time（可选，字符串 | 单位）：请参阅 skip_time 查询参数的说明。
- start（可选，字符串 | 单位）：请参阅 start 查询参数的说明。

forecast编辑

通过使用时间序列的历史行为来预测其未来的行为。

端点文档

client.ml.forecast({ job_id })

参数编辑

请求（对象）
- job_id（字符串）：异常检测作业的标识符。创建预测时，作业必须处于打开状态；否则，会发生错误。
- duration（可选，字符串 | -1 | 0）：请参阅 duration 查询参数的说明。
- expires_in（可选，字符串 | -1 | 0）：请参阅 expires_in 查询参数的说明。
- max_model_memory（可选，字符串）：请参阅 max_model_memory 查询参数的说明。

get_buckets编辑

检索一个或多个桶的异常检测作业结果。

端点文档

client.ml.getBuckets({ job_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- timestamp（可选，字符串 | 单位）：单个桶结果的时间戳。如果未指定此参数，则 API 将返回有关所有桶的信息。
- anomaly_score（可选，数字）：请参阅 anomaly_score 查询参数的说明。
- desc（可选，布尔值）：请参阅 desc 查询参数的说明。
- end（可选，字符串 | 单位）：请参阅 end 查询参数的说明。
- exclude_interim（可选，布尔值）：请参阅 exclude_interim 查询参数的说明。
- expand（可选，布尔值）：请参阅 expand 查询参数的说明。
- page（可选，{ from, size }）
- sort（可选，字符串）：请参阅 sort 查询参数的说明。
- start（可选，字符串 | 单位）：请参阅 start 查询参数的说明。
- from（可选，数字）：跳过指定数量的桶。
- size（可选，数字）：指定要获取的最大桶数。

get_calendar_events编辑

检索有关日历中计划事件的信息。

端点文档

client.ml.getCalendarEvents({ calendar_id })

参数编辑

请求（对象）
- calendar_id（字符串）：唯一标识日历的字符串。您可以使用 ID 列表或通配符表达式获取多个日历的信息。您可以使用 _all 或 * 或省略日历标识符来获取所有日历的信息。
- end（可选，字符串 | 单位）：指定获取时间戳早于此时间的事件。
- from（可选，数字）：跳过指定数量的事件。
- job_id（可选，字符串）：指定获取特定异常检测作业标识符或作业组的事件。它必须与日历标识符 _all 或 * 一起使用。
- size（可选，数字）：指定要获取的最大事件数。
- start（可选，字符串 | 单位）：指定获取时间戳晚于此时间的事件。

get_calendars编辑

检索日历的配置信息。

端点文档

client.ml.getCalendars({ ... })

参数编辑

请求（对象）
- calendar_id（可选，字符串）：唯一标识日历的字符串。您可以使用 ID 列表或通配符表达式获取多个日历的信息。您可以使用 _all 或 * 或省略日历标识符来获取所有日历的信息。
- page（可选，{ from, size }）：仅当省略日历标识符时才支持此对象。
- from（可选，数字）：跳过指定数量的日历。仅当省略日历标识符时才支持此参数。
- size（可选，数字）：指定要获取的最大日历数。仅当省略日历标识符时才支持此参数。

get_categories编辑

检索一个或多个类别的异常检测作业结果。

端点文档

client.ml.getCategories({ job_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- category_id（可选，字符串）：类别的标识符，在作业中是唯一的。如果既未指定类别 ID 也未指定 partition_field_value，则 API 将返回有关所有类别的信息。如果仅指定 partition_field_value，它将返回有关指定分区的所有类别的信息。
- page（可选，{ from, size }）：配置分页。此参数具有 from 和 size 属性。
- from（可选，数字）：跳过指定数量的类别。
- partition_field_value（可选，字符串）：仅返回指定分区的类别。
- size（可选，数字）：指定要获取的最大类别数。

get_data_frame_analytics编辑

检索数据帧分析作业的配置信息。

端点文档

client.ml.getDataFrameAnalytics({ ... })

参数编辑

请求（对象）
- id（可选，字符串）：数据帧分析作业的标识符。如果未指定此选项，则 API 将返回前一百个数据帧分析作业的信息。
- allow_no_match（可选，布尔值）：指定当请求
  1. 包含通配符表达式，并且没有匹配的数据帧分析作业。
  2. 包含 _all 字符串或没有标识符并且没有匹配项时该怎么办。
  3. 包含通配符表达式并且只有部分匹配时该怎么办。

默认值在没有匹配项时返回空 data_frame_analytics 数组，在部分匹配时返回结果子集。如果此参数为 false，则当没有匹配项或仅部分匹配时，请求将返回 404 状态代码。 from（可选，数字）：跳过指定数量的数据帧分析作业。 size（可选，数字）：指定要获取的最大数据帧分析作业数。 * *exclude_generated（可选，布尔值）：指示在检索时是否应从配置中删除某些字段。这允许配置采用可接受的格式进行检索，然后添加到另一个集群。

get_data_frame_analytics_stats编辑

检索数据帧分析作业的使用情况信息。

端点文档

client.ml.getDataFrameAnalyticsStats({ ... })

参数编辑

请求（对象）
- id（可选，字符串）：数据帧分析作业的标识符。如果未指定此选项，则 API 将返回前一百个数据帧分析作业的信息。
- allow_no_match（可选，布尔值）：指定当请求
  1. 包含通配符表达式，并且没有匹配的数据帧分析作业。
  2. 包含 _all 字符串或没有标识符并且没有匹配项时该怎么办。
  3. 包含通配符表达式并且只有部分匹配时该怎么办。

当没有匹配项时，默认值返回一个空的 data_frame_analytics 数组；当存在部分匹配项时，返回结果的子集。如果此参数为 false，则当没有匹配项或只有部分匹配项时，请求返回 404 状态代码。 from（可选，数字）：跳过指定数量的数据框分析作业。 size（可选，数字）：指定要获取的最大数据框分析作业数量。 * *verbose（可选，布尔值）：定义统计信息响应是否应为详细响应。

get_datafeed_stats编辑

检索数据馈送的使用情况信息。

端点文档

client.ml.getDatafeedStats({ ... })

参数编辑

请求（对象）
- datafeed_id（可选，字符串 | 字符串数组）：数据馈送的标识符。它可以是数据馈送标识符或通配符表达式。如果不指定这些选项之一，则 API 会返回有关所有数据馈送的信息。
- allow_no_match（可选，布尔值）：指定当请求
  1. 包含通配符表达式并且没有匹配的数据馈送时该怎么办。
  2. 包含 _all 字符串或没有标识符并且没有匹配项时该怎么办。
  3. 包含通配符表达式并且只有部分匹配时该怎么办。

默认值为 true，表示在没有匹配项时返回一个空的 datafeeds 数组，在有部分匹配项时返回结果的子集。如果此参数为 false，则当没有匹配项或只有部分匹配项时，请求返回 404 状态代码。

get_datafeeds编辑

检索数据馈送的配置信息。

端点文档

client.ml.getDatafeeds({ ... })

参数编辑

请求（对象）
- datafeed_id（可选，字符串 | 字符串数组）：数据馈送的标识符。它可以是数据馈送标识符或通配符表达式。如果不指定这些选项之一，则 API 会返回有关所有数据馈送的信息。
- allow_no_match（可选，布尔值）：指定当请求
  1. 包含通配符表达式并且没有匹配的数据馈送时该怎么办。
  2. 包含 _all 字符串或没有标识符并且没有匹配项时该怎么办。
  3. 包含通配符表达式并且只有部分匹配时该怎么办。

默认值为 true，表示在没有匹配项时返回一个空的 datafeeds 数组，在有部分匹配项时返回结果的子集。如果此参数为 false，则当没有匹配项或只有部分匹配项时，请求返回 404 状态代码。 * *exclude_generated（可选，布尔值）：指示在检索时是否应从配置中删除某些字段。这允许配置采用可接受的格式进行检索，然后添加到另一个集群。

get_filters编辑

检索过滤器。

端点文档

client.ml.getFilters({ ... })

参数编辑

请求（对象）
- filter_id（可选，字符串 | 字符串数组）：唯一标识过滤器的字符串。
- from（可选，数字）：跳过指定数量的过滤器。
- size（可选，数字）：指定要获取的最大过滤器数量。

get_influencers编辑

检索一个或多个影响因素的异常检测作业结果。

端点文档

client.ml.getInfluencers({ job_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- page（可选，{ from, size }）：配置分页。此参数具有 from 和 size 属性。
- desc（可选，布尔值）：如果为 true，则结果按降序排序。
- end（可选，字符串 | 单位）：返回时间戳早于此时间的影响因素。默认值表示未设置，并且结果不限于特定时间戳。
- exclude_interim（可选，布尔值）：如果为 true，则输出排除中间结果。默认情况下，包含中间结果。
- influencer_score（可选，数字）：返回异常分数大于或等于此值的影响因素。
- from（可选，数字）：跳过指定数量的影响因素。
- size（可选，数字）：指定要获取的最大影响因素数量。
- sort（可选，字符串）：指定请求的影响因素的排序字段。默认情况下，影响因素按 influencer_score 值排序。
- start（可选，字符串 | 单位）：返回时间戳晚于此时间的影响因素。默认值表示未设置，并且结果不限于特定时间戳。

get_job_stats编辑

检索异常检测作业的使用情况信息。

端点文档

client.ml.getJobStats({ ... })

参数编辑

请求（对象）
- job_id（可选，字符串）：异常检测作业的标识符。它可以是作业标识符、组名、作业列表或通配符表达式。如果不指定这些选项之一，则 API 会返回所有异常检测作业的信息。
- allow_no_match（可选，布尔值）：指定当请求
  1. 包含通配符表达式并且没有匹配的作业。
  2. 包含 _all 字符串或没有标识符，并且没有匹配项。
  3. 包含通配符表达式并且只有部分匹配时该怎么办。

如果为 true，则 API 在没有匹配项时返回一个空的 jobs 数组，在有部分匹配项时返回结果的子集。如果为 false，则当没有匹配项或只有部分匹配项时，API 返回 404 状态代码。

get_jobs编辑

检索异常检测作业的配置信息。

端点文档

client.ml.getJobs({ ... })

参数编辑

请求（对象）
- job_id（可选，字符串 | 字符串数组）：异常检测作业的标识符。它可以是作业标识符、组名或通配符表达式。如果不指定这些选项之一，则 API 会返回所有异常检测作业的信息。
- allow_no_match（可选，布尔值）：指定当请求
  1. 包含通配符表达式并且没有匹配的作业。
  2. 包含 _all 字符串或没有标识符，并且没有匹配项。
  3. 包含通配符表达式并且只有部分匹配时该怎么办。

默认值为 true，表示在没有匹配项时返回一个空的 jobs 数组，在有部分匹配项时返回结果的子集。如果此参数为 false，则当没有匹配项或只有部分匹配项时，请求返回 404 状态代码。 * *exclude_generated（可选，布尔值）：指示在检索时是否应从配置中删除某些字段。这允许配置采用可接受的格式进行检索，然后添加到另一个集群。

get_memory_stats编辑

返回有关 ML 如何使用内存的信息。

端点文档

client.ml.getMemoryStats({ ... })

参数编辑

请求（对象）
- node_id（可选，字符串）：要定位的集群中特定节点的名称。例如，nodeId1,nodeId2 或 ml:true
- human（可选，布尔值）：指定此查询参数以在响应中包含带单位的字段。否则，响应中仅返回 _in_bytes 大小。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

get_model_snapshot_upgrade_stats编辑

获取正在进行的异常检测作业模型快照升级的统计信息。

端点文档

client.ml.getModelSnapshotUpgradeStats({ job_id, snapshot_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- snapshot_id（字符串）：唯一标识模型快照的数字字符串。您可以使用列表或通配符表达式获取多个快照的信息。您可以通过使用 _all、将 * 指定为快照 ID 或省略快照 ID 来获取所有快照。
- allow_no_match（可选，布尔值）：指定当请求
  - 包含通配符表达式并且没有匹配的作业。
  - 包含 _all 字符串或没有标识符，并且没有匹配项。
  - 包含通配符表达式并且只有部分匹配时该怎么办。

默认值为 true，表示在没有匹配项时返回一个空的 jobs 数组，在有部分匹配项时返回结果的子集。如果此参数为 false，则当没有匹配项或只有部分匹配项时，请求返回 404 状态代码。

get_model_snapshots编辑

检索有关模型快照的信息。

端点文档

client.ml.getModelSnapshots({ job_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- snapshot_id（可选，字符串）：唯一标识模型快照的数字字符串。您可以使用列表或通配符表达式获取多个快照的信息。您可以通过使用 _all、将 * 指定为快照 ID 或省略快照 ID 来获取所有快照。
- desc（可选，布尔值）：请参阅 desc 查询参数的说明。
- end（可选，字符串 | 单位）：请参阅 end 查询参数的说明。
- page（可选，{ from, size }）
- sort（可选，字符串）：有关 sort 查询参数的说明，请参阅相关说明。
- start（可选，字符串 | 单位）：请参阅 start 查询参数的说明。
- from（可选，数字）：跳过指定数量的快照。
- size（可选，数字）：指定要获取的最大快照数量。

get_overall_buckets编辑

检索汇总多个异常检测作业的存储桶结果的总体存储桶结果。

端点文档

client.ml.getOverallBuckets({ job_id })

参数编辑

请求（对象）
- job_id（字符串）：异常检测作业的标识符。它可以是作业标识符、组名、作业或组的列表，或通配符表达式。

您可以使用 _all 或通过将 * 指定为 <job_id> 来汇总所有异常检测作业的存储桶结果。 allow_no_match（可选，布尔值）：请参阅 allow_no_match 查询参数的描述。 bucket_span（可选，字符串 | -1 | 0）：请参阅 bucket_span 查询参数的描述。 end（可选，字符串 | 单位）：请参阅 end 查询参数的描述。 exclude_interim（可选，布尔值）：请参阅 exclude_interim 查询参数的描述。 overall_score（可选，数字 | 字符串）：请参阅 overall_score 查询参数的描述。 start（可选，字符串 | 单位）：请参阅 start 查询参数的描述。 * *top_n（可选，数字）：请参阅 top_n 查询参数的描述。

get_records编辑

检索异常检测作业的异常记录。

端点文档

client.ml.getRecords({ job_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- desc（可选，布尔值）：请参阅 desc 查询参数的说明。
- end（可选，字符串 | 单位）：请参阅 end 查询参数的说明。
- exclude_interim（可选，布尔值）：请参阅 exclude_interim 查询参数的说明。
- page（可选，{ from, size }）
- record_score（可选，数字）：请参阅 record_score 查询参数的描述。
- sort（可选，字符串）：有关 sort 查询参数的说明，请参阅相关说明。
- start（可选，字符串 | 单位）：请参阅 start 查询参数的说明。
- from（可选，数字）：跳过指定数量的记录。
- size（可选，数字）：指定要获取的最大记录数。

get_trained_models编辑

检索训练推理模型的配置信息。

端点文档

client.ml.getTrainedModels({ ... })

参数编辑

请求（对象）
- model_id（可选，字符串）：训练模型的唯一标识符。
- allow_no_match（可选，布尔值）：指定当请求
  - 包含通配符表达式，并且没有匹配的模型。
  - 包含 _all 字符串或没有标识符，并且没有匹配项。
  - 包含通配符表达式并且只有部分匹配时该怎么办。

如果为 true，则在没有匹配项时返回空数组，在部分匹配时返回结果的子集。 decompress_definition（可选，布尔值）：指定包含的模型定义应作为 JSON 映射（true）还是自定义压缩格式（false）返回。 exclude_generated（可选，布尔值）：指示在检索时是否应从配置中删除某些字段。这允许配置采用可接受的格式进行检索，然后添加到另一个集群。 from（可选，数字）：跳过指定数量的模型。 include（可选，枚举（“definition” | “feature_importance_baseline” | “hyperparameters” | “total_feature_importance” | “definition_status”））：要在响应正文中包含的可选字段的逗号分隔字符串。 size（可选，数字）：指定要获取的最大模型数。 tags（可选，字符串）：标签的逗号分隔字符串。训练后的模型可以有多个标签，也可以没有标签。如果提供，则仅返回包含所有提供的标签的训练模型。

get_trained_models_stats编辑

检索训练推理模型的使用信息。

端点文档

client.ml.getTrainedModelsStats({ ... })

参数编辑

请求（对象）
- model_id（可选，字符串 | 字符串数组）：训练模型或模型别名的唯一标识符。它可以是列表或通配符表达式。
- allow_no_match（可选，布尔值）：指定当请求
  - 包含通配符表达式，并且没有匹配的模型。
  - 包含 _all 字符串或没有标识符，并且没有匹配项。
  - 包含通配符表达式并且只有部分匹配时该怎么办。

如果为 true，则在没有匹配项时返回空数组，在部分匹配时返回结果的子集。 from（可选，数字）：跳过指定数量的模型。 size（可选，数字）：指定要获取的最大模型数。

infer_trained_model编辑

评估训练的模型。

端点文档

client.ml.inferTrainedModel({ model_id, docs })

参数编辑

请求（对象）
- model_id（字符串）：训练模型的唯一标识符。
- docs (Record<string, 用户定义的值>[])：要传递给模型进行推理的对象数组。这些对象应包含与您配置的训练模型输入匹配的字段。通常，对于 NLP 模型，字段名称为 text_field。目前，对于 NLP 模型，只允许使用单个值。
- inference_config（可选，{ regression, classification, text_classification, zero_shot_classification, fill_mask, ner, pass_through, text_embedding, text_expansion, question_answering }）：要在 API 调用上应用的推理配置更新
- timeout（可选，字符串 | -1 | 0）：控制等待推理结果的时间量。

info编辑

返回机器学习使用的默认值和限制。

端点文档

client.ml.info()

open_job编辑

打开一个或多个异常检测作业。

端点文档

client.ml.openJob({ job_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- timeout（可选，字符串 | -1 | 0）：请参阅 timeout 查询参数的说明。

post_calendar_events编辑

在日历中发布预定事件。

端点文档

client.ml.postCalendarEvents({ calendar_id, events })

参数编辑

请求（对象）
- calendar_id（字符串）：唯一标识日历的字符串。
- events ({ calendar_id, event_id, description, end_time, start_time }[])：一个或多个预定事件的列表。事件的开始和结束时间可以指定为自纪元以来的整数毫秒数，也可以指定为 ISO 8601 格式的字符串。

post_data编辑

将数据发送到异常检测作业以进行分析。

端点文档

client.ml.postData({ job_id })

参数编辑

请求（对象）
- job_id（字符串）：异常检测作业的标识符。作业必须处于打开状态才能接收和处理数据。
- data（可选，TData[]）
- reset_end（可选，字符串 | 单位）：指定存储桶重置范围的结束时间。
- reset_start（可选，字符串 | 单位）：指定存储桶重置范围的开始时间。

preview_data_frame_analytics编辑

预览在给定数据帧分析配置的情况下将要分析的内容。

端点文档

client.ml.previewDataFrameAnalytics({ ... })

参数编辑

请求（对象）
- id（可选，字符串）：数据帧分析作业的标识符。
- config（可选，{ source, analysis, model_memory_limit, max_num_threads, analyzed_fields }）：如创建数据帧分析作业中所述的数据帧分析配置。请注意，在此 API 的上下文中，不需要提供 id 和 dest。

preview_datafeed编辑

预览数据馈送。

端点文档

client.ml.previewDatafeed({ ... })

参数编辑

请求（对象）
- datafeed_id（可选，字符串）：唯一标识数据馈送的数字字符串。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。注意：如果使用此路径参数，则无法在请求正文中提供数据馈送或异常检测作业配置详细信息。
- datafeed_config（可选，{ aggregations, chunking_config, datafeed_id, delayed_data_check_config, frequency, indices, indices_options, job_id, max_empty_searches, query, query_delay, runtime_mappings, script_fields, scroll_size }）：要预览的数据馈送定义。
- job_config（可选，{ allow_lazy_open, analysis_config, analysis_limits, background_persist_interval, custom_settings, daily_model_snapshot_retention_after_days, data_description, datafeed_config, description, groups, job_id, job_type, model_plot_config, model_snapshot_retention_days, renormalization_window_days, results_index_name, results_retention_days }）：与数据馈送关联的异常检测作业的配置详细信息。如果 datafeed_config 对象不包含引用现有异常检测作业的 job_id，则必须提供此 job_config 对象。如果同时包含 job_id 和 job_config，则使用后者信息。除非还提供 datafeed_config 对象，否则不能指定 job_config 对象。
- start（可选，字符串 | 单位）：数据馈送预览应从其开始的开始时间
- end（可选，字符串 | 单位）：数据馈送预览应停止的结束时间

put_calendar编辑

实例化日历。

端点文档

client.ml.putCalendar({ calendar_id })

参数编辑

请求（对象）
- calendar_id（字符串）：唯一标识日历的字符串。
- job_ids（可选，字符串数组）：异常检测作业标识符数组。
- description（可选，字符串）：日历的描述。

put_calendar_job编辑

将异常检测作业添加到日历。

端点文档

client.ml.putCalendarJob({ calendar_id, job_id })

参数编辑

请求（对象）
- calendar_id（字符串）：唯一标识日历的字符串。
- job_id（字符串）：异常检测作业的标识符。它可以是作业标识符、组名称或作业或组的列表。

put_data_frame_analytics编辑

实例化数据帧分析作业。

端点文档

client.ml.putDataFrameAnalytics({ id, analysis, dest, source })

参数编辑

请求（对象）
- id（字符串）：数据帧分析作业的标识符。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
- analysis（{ classification, outlier_detection, regression }）：分析配置，包含执行以下类型分析之一所需的信息：分类、异常值检测或回归。
- dest（{ index, results_field }）：目标配置。
- source（{ index, query, runtime_mappings, _source }）：如何获取分析数据的配置。
- allow_lazy_start（可选，布尔值）：指定当机器学习节点容量不足以立即将此作业分配给节点时，该作业是否可以启动。如果设置为 false 并且无法立即找到具有运行作业容量的机器学习节点，则 API 将返回错误。如果设置为 true，则 API 不会返回错误；该作业将在 starting 状态下等待，直到有足够的机器学习节点容量可用。此行为还受集群范围的 xpack.ml.max_lazy_ml_nodes 设置的影响。
- analyzed_fields（可选，{ includes, excludes }）：指定 includes 和/或 excludes 模式以选择将包含在分析中的字段。excludes 中指定的模式最后应用，因此 excludes 优先。换句话说，如果在 includes 和 excludes 中都指定了相同的字段，则该字段将不会包含在分析中。如果未设置 analyzed_fields，则仅包含相关字段。例如，异常值检测的所有数字字段。支持的字段因分析类型而异。异常值检测需要数字或 boolean 数据进行分析。算法不支持缺失值，因此将忽略数据类型不是数字或布尔值的字段。包含字段包含缺失值、空值或数组的文档也将被忽略。因此，dest 索引可能包含没有异常值分数的文档。回归支持 numeric、boolean、text、keyword 和 ip 数据类型的字段。它还可以容忍缺失值。支持的字段包含在分析中，其他字段被忽略。包含字段包含具有两个或多个值的数组的文档也将被忽略。不包含结果字段的 dest 索引中的文档不包括在回归分析中。分类支持 numeric、boolean、text、keyword 和 ip 数据类型的字段。它还可以容忍缺失值。支持的字段包含在分析中，其他字段被忽略。包含字段包含具有两个或多个值的数组的文档也将被忽略。不包含结果字段的 dest 索引中的文档不包括在分类分析中。可以通过将序数变量值映射到单个数字来改进分类分析。例如，在年龄范围的情况下，您可以将值建模为 0-14 = 0、15-24 = 1、25-34 = 2，依此类推。
- description （可选，字符串）：作业的描述。
- max_num_threads（可选，数字）：分析中使用的最大线程数。使用更多线程可能会减少完成分析所需的时间，但会占用更多 CPU 资源。请注意，除了分析本身之外，该过程可能还会使用额外的线程来执行操作功能。
- model_memory_limit （可选，字符串）：允许用于分析处理的最大内存资源（近似值）。如果 elasticsearch.yml 文件包含 xpack.ml.max_model_memory_limit 设置，则在尝试创建 model_memory_limit 值大于该设置的数据帧分析作业时会发生错误。
- headers（可选，Record<string, string | string[]>）
- version（可选，字符串）

put_datafeed编辑

实例化数据馈送。

端点文档

client.ml.putDatafeed({ datafeed_id })

参数编辑

请求（对象）
- datafeed_id （字符串）：唯一标识数据馈送的数字字符串。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
- aggregations（可选，Record<string, { aggregations, meta, adjacency_matrix, auto_date_histogram, avg, avg_bucket, boxplot, bucket_script, bucket_selector, bucket_sort, bucket_count_ks_test, bucket_correlation, cardinality, categorize_text, children, composite, cumulative_cardinality, cumulative_sum, date_histogram, date_range, derivative, diversified_sampler, extended_stats, extended_stats_bucket, frequent_item_sets, filter, filters, geo_bounds, geo_centroid, geo_distance, geohash_grid, geo_line, geotile_grid, geohex_grid, global, histogram, ip_range, ip_prefix, inference, line, matrix_stats, max, max_bucket, median_absolute_deviation, min, min_bucket, missing, moving_avg, moving_percentiles, moving_fn, multi_terms, nested, normalize, parent, percentile_ranks, percentiles, percentiles_bucket, range, rare_terms, rate, reverse_nested, sampler, scripted_metric, serial_diff, significant_terms, significant_text, stats, stats_bucket, string_stats, sum, sum_bucket, terms, top_hits, t_test, top_metrics, value_count, weighted_avg, variable_width_histogram }>）：如果设置，数据馈送将执行聚合搜索。对聚合的支持有限，并且应该仅用于低基数数据。
- chunking_config（可选，{ mode, time_span }）：数据馈送可能需要搜索很长一段时间，几个月或几年。此搜索被分成时间块，以确保 Elasticsearch 上的负载得到管理。分块配置控制如何计算这些时间块的大小；这是一个高级配置选项。
- delayed_data_check_config（可选，{ check_window, enabled }）：指定数据馈送是否检查缺失数据以及窗口的大小。数据馈送可以选择搜索已读取的索引，以确定是否有任何数据随后被添加到索引中。如果发现数据缺失，则很好地表明 query_delay 设置得太低，并且数据在数据馈送通过该时间点后被索引。此检查仅在实时数据馈送上运行。
- frequency（可选，字符串 | -1 | 0）：当数据馈送实时运行时，执行计划查询的时间间隔。默认值是短存储桶跨度的存储桶跨度，或者对于较长的存储桶跨度，是存储桶跨度的合理分数。当 frequency 短于存储桶跨度时，将写入最后一个（部分）存储桶的中间结果，然后最终被完整的存储桶结果覆盖。如果数据馈送使用聚合，则此值必须可以被日期直方图聚合的间隔整除。
- indices（可选，字符串 | 字符串[]）：索引名称数组。支持通配符。如果任何索引位于远程集群中，则机器学习节点必须具有 remote_cluster_client 角色。
- indices_options（可选，{ allow_no_indices, expand_wildcards, ignore_unavailable, ignore_throttled }）：指定在搜索期间使用的索引扩展选项
- job_id（可选，字符串）：异常检测作业的标识符。
- max_empty_searches（可选，数字）：如果实时数据馈送从未看到任何数据（包括在任何初始训练期间），则在多次实时搜索返回无文档后，它会自动停止并关闭关联的作业。换句话说，它在实时运行 frequency 乘以 max_empty_searches 次后停止。如果未设置，则没有结束时间且看不到任何数据的数据馈送将保持启动状态，直到被明确停止。默认情况下，它未设置。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：Elasticsearch 查询领域特定语言 (DSL)。此值对应于 Elasticsearch 搜索 POST 正文中的查询对象。支持 Elasticsearch 的所有选项都可以使用，因为此对象按原样传递给 Elasticsearch。
- query_delay（可选，字符串 | -1 | 0）：查询数据落后于实时数据的秒数。例如，如果从上午 10:04 开始的数据在上午 10:06 之前可能无法在 Elasticsearch 中搜索，请将此属性设置为 120 秒。默认值在 60s 和 120s 之间随机选择。当同一节点上运行多个作业时，这种随机性可以提高查询性能。
- runtime_mappings（可选，Record<string, { fetch_fields, format, input_field, target_field, target_index, script, type }>）：指定数据馈送搜索的运行时字段。
- script_fields（可选，Record<string, { script, ignore_failure }>）：指定评估自定义表达式并将脚本字段返回到数据馈送的脚本。作业中的检测器配置对象可以包含使用这些脚本字段的函数。
- scroll_size（可选，数字）：当数据馈送不使用聚合时，在 Elasticsearch 搜索中使用的 size 参数。最大值是 index.max_result_window 的值，默认情况下为 10,000。
- headers（可选，Record<string, string | string[]>）
- allow_no_indices（可选，布尔值）：如果为 true，则解析为无具体索引的通配符索引表达式将被忽略。这包括 _all 字符串或未指定索引的情况。
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表。
- ignore_throttled（可选，布尔值）：如果为 true，则在冻结时忽略具体的、扩展的或别名的索引。
- ignore_unavailable（可选，布尔值）：如果为 true，则忽略不可用的索引（丢失或关闭）。

put_filter编辑

实例化过滤器。

端点文档

client.ml.putFilter({ filter_id })

参数编辑

请求（对象）
- filter_id （字符串）：唯一标识过滤器的字符串。
- description（可选，字符串）：过滤器的描述。
- items（可选，字符串[]）：过滤器的项目。通配符 * 可用于项目开头或结尾。每个过滤器最多允许 10000 个项目。

put_job编辑

实例化异常检测作业。

端点文档

client.ml.putJob({ job_id, analysis_config, data_description })

参数编辑

请求（对象）
- job_id（字符串）：异常检测作业的标识符。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
- analysis_config（{ bucket_span, categorization_analyzer, categorization_field_name, categorization_filters, detectors, influencers, latency, model_prune_window, multivariate_by_fields, per_partition_categorization, summary_count_field_name }）：指定如何分析数据。创建作业后，您将无法更改分析配置；所有属性均为信息性属性。
- data_description（{ format, time_field, time_format, field_delimiter }）：使用 post 数据 API 向作业发送数据时定义输入数据的格式。请注意，配置数据馈送时，会自动设置这些属性。通过 post 数据 API 接收数据时，不会将其存储在 Elasticsearch 中。仅保留异常检测的结果。
- allow_lazy_open（可选，布尔值）：高级配置选项。指定当机器学习节点容量不足以立即将其分配给节点时，此作业是否可以打开。默认情况下，如果无法立即找到具有运行作业能力的机器学习节点，则打开异常检测作业 API 会返回错误。但是，这也受集群范围的 xpack.ml.max_lazy_ml_nodes 设置的约束。如果此选项设置为 true，则打开异常检测作业 API 不会返回错误，并且作业将在打开状态下等待，直到有足够的机器学习节点容量可用。
- analysis_limits（可选，{ categorization_examples_limit, model_memory_limit }）：可以对将数学模型保存在内存中所需的资源应用限制。这些限制是近似值，可以为每个作业设置。它们不控制其他进程使用的内存，例如 Elasticsearch Java 进程。
- background_persist_interval（可选，字符串 | -1 | 0）：高级配置选项。每次定期持久保存模型之间的时间。默认值是 3 到 4 小时之间的随机值，这避免了所有作业都在完全相同的时间持久保存。允许的最小值为 1 小时。对于非常大的模型（几 GB），持久保存可能需要 10-20 分钟，因此请勿将 background_persist_interval 值设置得太低。
- custom_settings（可选，用户定义的值）：高级配置选项。包含有关作业的自定义元数据。
- daily_model_snapshot_retention_after_days（可选，数字）：高级配置选项，它会影响自动删除此作业的旧模型快照。它指定了一段时间（以天为单位），在此之后，每天仅保留第一个快照。此时间段是相对于此作业的最新快照的时间戳的。有效值的范围从 0 到 model_snapshot_retention_days。
- datafeed_config（可选，{ aggregations, chunking_config, datafeed_id, delayed_data_check_config, frequency, indices, indices_options, job_id, max_empty_searches, query, query_delay, runtime_mappings, script_fields, scroll_size }）：为异常检测作业定义数据馈送。如果启用了 Elasticsearch 安全功能，则数据馈送会记住创建它的用户在创建时拥有的角色，并使用相同的角色运行查询。如果您提供辅助授权标头，则将使用这些凭据。
- description （可选，字符串）：作业的描述。
- groups（可选，字符串[]）：作业组的列表。一个作业可以不属于任何组，也可以属于多个组。
- model_plot_config（可选，{ annotations_enabled, enabled, terms }）：此高级配置选项将模型信息与结果一起存储。它提供了对异常检测的更详细的视图。如果启用模型图，则可能会增加系统的性能开销；对于具有许多实体的作业，这是不可行的。模型图提供了模型及其边界的简化和指示性视图。它不显示复杂的功能，例如多元相关性或多模态数据。因此，偶尔可能会报告在模型图中看不到的异常。模型图配置可以在创建或以后更新作业时配置。如果遇到性能问题，则必须禁用它。
- model_snapshot_retention_days（可选，数字）：高级配置选项，它会影响自动删除此作业的旧模型快照。它指定了保留快照的最长时间段（以天为单位）。此时间段是相对于此作业的最新快照的时间戳的。默认情况下，将删除比最新快照旧十天的快照。
- renormalization_window_days（可选，数字）：高级配置选项。在看到新数据时，应用分数调整的时间段。默认值为 30 天或 100 个存储桶跨度中的较长者。
- results_index_name（可选，字符串）：影响机器学习结果索引名称的文本字符串。默认情况下，该作业会生成一个名为 .ml-anomalies-shared 的索引。
- results_retention_days（可选，数字）：高级配置选项。保留结果的时间段（以天为单位）。年龄是相对于最新存储桶结果的时间戳计算的。如果此属性具有非空值，则每天一次在 00:30（服务器时间），将从 Elasticsearch 中删除比最新存储桶结果旧指定天数的结果。默认值为 null，这意味着将保留所有结果。系统生成的注释在保留目的方面也被视为结果；它们在与结果相同的天数后被删除。用户添加的注释将永久保留。

put_trained_model编辑

创建推理训练模型。

端点文档

client.ml.putTrainedModel({ model_id })

参数编辑

请求（对象）
- model_id（字符串）：训练模型的唯一标识符。
- compressed_definition（可选，字符串）：模型的压缩（GZip 压缩和 Base64 编码）推理定义。如果指定了 compressed_definition，则不能指定 definition。
- definition（可选，{ preprocessors, trained_model }）：模型的推理定义。如果指定了 definition，则不能指定 compressed_definition。
- description（可选，字符串）：推理训练模型的人类可读描述。
- inference_config（可选，{ regression, classification, text_classification, zero_shot_classification, fill_mask, ner, pass_through, text_embedding, text_expansion, question_answering }）：推理的默认配置。这可以是回归配置或分类配置。它必须与基础 definition.trained_model 的 target_type 匹配。对于预打包模型（如 ELSER），不需要配置。
- input（可选，{ field_names }）：模型定义的输入字段名称。
- metadata（可选，用户定义的值）：包含有关模型的元数据的对象映射。
- model_type（可选，枚举（"tree_ensemble" | "lang_ident" | "pytorch"））：模型类型。
- model_size_bytes（可选，数字）：将训练模型保存在内存中的估计内存使用量（以字节为单位）。仅当 defer_definition_decompression 为 true 或未提供模型定义时，才支持此属性。
- platform_architecture（可选，字符串）：训练模式的平台架构（如果适用）。如果模型仅在一个平台上工作，因为它针对特定的处理器架构和操作系统组合进行了大量优化，则此字段指定哪个平台。字符串的格式必须与 Elasticsearch 使用的平台标识符匹配，因此必须是以下之一：linux-x86_64、linux-aarch64、darwin-x86_64、darwin-aarch64 或 windows-x86_64。对于可移植模型（独立于处理器架构或操作系统功能的模型），请将此字段保留为空。
- tags（可选，字符串[]）：用于组织模型的标记数组。
- prefix_strings（可选，{ ingest, search }）：在推理时应用的可选前缀字符串
- defer_definition_decompression（可选，布尔值）：如果设置为 true 并提供了 compressed_definition，则请求会延迟定义解压缩并跳过相关验证。
- wait_for_completion（可选，布尔值）：是否等待所有子操作（例如模型下载）完成。

put_trained_model_alias编辑

创建新的模型别名（或重新分配现有的模型别名）以引用训练模型

端点文档

client.ml.putTrainedModelAlias({ model_alias, model_id })

参数编辑

请求（对象）
- model_alias（字符串）：要创建或更新的别名。此值不能以数字结尾。
- model_id（字符串）：别名所引用的训练模型的标识符。
- reassign（可选，布尔值）：指定如果别名已分配给不同的模型，则是否将其重新分配给指定的训练模型。如果别名已分配并且此参数为 false，则 API 会返回错误。

put_trained_model_definition_part编辑

创建训练模型定义的一部分

端点文档

client.ml.putTrainedModelDefinitionPart({ model_id, part, definition, total_definition_length, total_parts })

参数编辑

请求（对象）
- model_id（字符串）：训练模型的唯一标识符。
- part（数字）：定义部分编号。加载定义以进行推理时，定义部分将按照其部分编号的顺序进行流式传输。第一部分必须为 0，最后一部分必须为 total_parts - 1。
- definition（字符串）：模型的定义部分。必须是 Base64 编码的字符串。
- total_definition_length（数字）：未压缩定义的总长度（以字节为单位）。不是 Base64 编码的。
- total_parts（数字）：将要上传的部件总数。必须大于 0。

put_trained_model_vocabulary编辑

创建训练模型词汇表

端点文档

client.ml.putTrainedModelVocabulary({ model_id, vocabulary })

参数编辑

请求（对象）
- model_id（字符串）：训练模型的唯一标识符。
- vocabulary（字符串[]）：模型词汇表，不能为空。
- merges（可选，字符串[]）：如果分词器需要，则为可选的模型合并。
- scores（可选，数字数组）：如果分词器需要，则为可选的词汇价值分数。

reset_job编辑

重置现有的异常检测作业。

端点文档

client.ml.resetJob({ job_id })

参数编辑

请求（对象）
- job_id（字符串）：要重置的作业的 ID。
- wait_for_completion（可选，布尔值）：此请求是否应在操作完成之前等待返回。
- delete_user_annotations （可选，布尔值）：指定在重置作业时，是否应删除用户添加的注释以及任何自动生成的注释。

revert_model_snapshot编辑

恢复到特定的快照。

端点文档

client.ml.revertModelSnapshot({ job_id, snapshot_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- snapshot_id（字符串）：您可以将 empty 指定为 <snapshot_id>。恢复到空快照意味着异常检测作业在启动时将开始从头开始学习新模型。
- delete_intervening_results（可选，布尔值）：请参阅 delete_intervening_results 查询参数的描述。

set_upgrade_mode编辑

设置集群范围的 upgrade_mode 设置，为升级准备机器学习索引。

端点文档

client.ml.setUpgradeMode({ ... })

参数编辑

请求（对象）
- enabled（可选，布尔值）：如果为 true，则启用 upgrade_mode，这将暂时停止所有作业和数据馈送任务，并禁止启动新的作业和数据馈送任务。
- timeout（可选，字符串 | -1 | 0）：等待请求完成的时间。

start_data_frame_analytics编辑

启动数据帧分析作业。

端点文档

client.ml.startDataFrameAnalytics({ id })

参数编辑

请求（对象）
- id（字符串）：数据帧分析作业的标识符。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
- timeout（可选，字符串 | -1 | 0）：控制等待数据帧分析作业启动的时间。

start_datafeed编辑

启动一个或多个数据馈送。

端点文档

client.ml.startDatafeed({ datafeed_id })

参数编辑

请求（对象）
- datafeed_id （字符串）：唯一标识数据馈送的数字字符串。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
- end（可选，字符串 | 单位）：请参阅 end 查询参数的说明。
- start（可选，字符串 | 单位）：请参阅 start 查询参数的说明。
- timeout（可选，字符串 | -1 | 0）：请参阅 timeout 查询参数的说明。

start_trained_model_deployment编辑

启动已训练模型部署。

端点文档

client.ml.startTrainedModelDeployment({ model_id })

参数编辑

请求（对象）
- model_id（字符串）：已训练模型的唯一标识符。目前，仅支持 PyTorch 模型。
- cache_size（可选，数字 | 字符串）：模型在每个节点上（JVM 堆外部内存中）的推理缓存大小。默认值与 model_size_bytes 大小相同。要禁用缓存，可以提供 0b。
- deployment_id（可选，字符串）：模型部署的唯一标识符。
- number_of_allocations（可选，数字）：已部署模型的每个节点上的模型分配数量。节点上的所有分配共享内存中模型的相同副本，但使用单独的线程集来评估模型。增加此值通常会提高吞吐量。如果此设置大于硬件线程数，它将自动更改为小于硬件线程数的值。
- priority（可选，枚举（"normal" | "low"））：部署优先级。
- queue_capacity（可选，数字）：指定队列中允许的推理请求数量。在请求数量超过此值后，新请求将被拒绝，并显示 429 错误。
- threads_per_allocation（可选，数字）：设置每个模型分配在推理期间使用的线程数。这通常会提高推理速度。推理过程是一个计算密集型过程；任何大于机器上可用硬件线程数的数字都不会提高推理速度。如果此设置大于硬件线程数，它将自动更改为小于硬件线程数的值。
- timeout（可选，字符串 | -1 | 0）：指定等待模型部署的时间。
- wait_for（可选，枚举（"started" | "starting" | "fully_allocated"））：指定在返回之前要等待的分配状态。

stop_data_frame_analytics编辑

停止一个或多个数据帧分析作业。

端点文档

client.ml.stopDataFrameAnalytics({ id })

参数编辑

请求（对象）
- id（字符串）：数据帧分析作业的标识符。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
- allow_no_match（可选，布尔值）：指定当请求
  1. 包含通配符表达式，并且没有匹配的数据帧分析作业。
  2. 包含 _all 字符串或没有标识符，并且没有匹配项。
  3. 包含通配符表达式并且只有部分匹配时该怎么办。

默认值为 true，当没有匹配项时返回一个空的 data_frame_analytics 数组，当有部分匹配项时返回结果的子集。如果此参数为 false，则当没有匹配项或只有部分匹配项时，请求将返回 404 状态代码。 force（可选，布尔值）：如果为 true，则强制停止数据帧分析作业。 timeout（可选，字符串 | -1 | 0）：控制等待数据帧分析作业停止的时间。默认为 20 秒。

stop_datafeed编辑

停止一个或多个数据馈送。

端点文档

client.ml.stopDatafeed({ datafeed_id })

参数编辑

请求（对象）
- datafeed_id（字符串）：数据馈送的标识符。您可以通过使用逗号分隔的数据馈送列表或通配符表达式，在单个 API 请求中停止多个数据馈送。您可以通过使用 _all 或将 * 指定为标识符来关闭所有数据馈送。
- allow_no_match（可选，布尔值）：请参阅 allow_no_match 查询参数的说明。
- force（可选，布尔值）：请参阅 force 查询参数的描述。
- timeout（可选，字符串 | -1 | 0）：请参阅 timeout 查询参数的说明。

stop_trained_model_deployment编辑

停止已训练模型部署。

端点文档

client.ml.stopTrainedModelDeployment({ model_id })

参数编辑

请求（对象）
- model_id（字符串）：训练模型的唯一标识符。
- allow_no_match（可选，布尔值）：指定当请求：包含通配符表达式并且没有匹配的部署时；包含 _all 字符串或没有标识符并且没有匹配项时；或包含通配符表达式并且只有部分匹配项时该怎么做。默认情况下，当没有匹配项时，它返回一个空数组，当有部分匹配项时，它返回结果的子集。如果为 false，则当没有匹配项或只有部分匹配项时，请求将返回 404 状态代码。
- force（可选，布尔值）：强制停止部署，即使它被摄入管道使用。在重新启动模型部署之前，您不能使用这些管道。

update_data_frame_analytics编辑

更新数据帧分析作业的某些属性。

端点文档

client.ml.updateDataFrameAnalytics({ id })

参数编辑

请求（对象）
- id（字符串）：数据帧分析作业的标识符。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
- description （可选，字符串）：作业的描述。
- model_memory_limit （可选，字符串）：允许用于分析处理的最大内存资源（近似值）。如果 elasticsearch.yml 文件包含 xpack.ml.max_model_memory_limit 设置，则在尝试创建 model_memory_limit 值大于该设置的数据帧分析作业时会发生错误。
- max_num_threads（可选，数字）：分析中使用的最大线程数。使用更多线程可能会减少完成分析所需的时间，但会占用更多 CPU 资源。请注意，除了分析本身之外，该过程可能还会使用额外的线程来执行操作功能。
- allow_lazy_start（可选，布尔值）：指定当没有足够的机器学习节点容量立即将此作业分配给节点时，此作业是否可以启动。

update_datafeed编辑

更新数据馈送的某些属性。

端点文档

client.ml.updateDatafeed({ datafeed_id })

参数编辑

请求（对象）
- datafeed_id （字符串）：唯一标识数据馈送的数字字符串。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。
- aggregations（可选，Record<string, { aggregations, meta, adjacency_matrix, auto_date_histogram, avg, avg_bucket, boxplot, bucket_script, bucket_selector, bucket_sort, bucket_count_ks_test, bucket_correlation, cardinality, categorize_text, children, composite, cumulative_cardinality, cumulative_sum, date_histogram, date_range, derivative, diversified_sampler, extended_stats, extended_stats_bucket, frequent_item_sets, filter, filters, geo_bounds, geo_centroid, geo_distance, geohash_grid, geo_line, geotile_grid, geohex_grid, global, histogram, ip_range, ip_prefix, inference, line, matrix_stats, max, max_bucket, median_absolute_deviation, min, min_bucket, missing, moving_avg, moving_percentiles, moving_fn, multi_terms, nested, normalize, parent, percentile_ranks, percentiles, percentiles_bucket, range, rare_terms, rate, reverse_nested, sampler, scripted_metric, serial_diff, significant_terms, significant_text, stats, stats_bucket, string_stats, sum, sum_bucket, terms, top_hits, t_test, top_metrics, value_count, weighted_avg, variable_width_histogram }>）：如果设置，数据馈送将执行聚合搜索。对聚合的支持有限，并且应该仅用于低基数数据。
- chunking_config（可选，{ mode, time_span }）：数据馈送可能会在很长一段时间内（几个月或几年）进行搜索。此搜索被分成多个时间块，以确保 Elasticsearch 上的负载得到管理。分块配置控制如何计算这些时间块的大小；这是一个高级配置选项。
- delayed_data_check_config（可选，{ check_window, enabled }）：指定数据馈送是否检查缺失数据以及窗口的大小。数据馈送可以选择搜索已读取的索引，以确定是否有任何数据随后被添加到索引中。如果发现数据缺失，则很好地表明 query_delay 设置得太低，并且数据在数据馈送通过该时间点后被索引。此检查仅在实时数据馈送上运行。
- frequency（可选，字符串 | -1 | 0）：当数据馈送实时运行时，执行计划查询的时间间隔。默认值是短存储桶跨度的存储桶跨度，或者对于较长的存储桶跨度，是存储桶跨度的合理分数。当 frequency 短于存储桶跨度时，将写入最后一个（部分）存储桶的中间结果，然后最终被完整的存储桶结果覆盖。如果数据馈送使用聚合，则此值必须可以被日期直方图聚合的间隔整除。
- indices（可选，字符串数组）：索引名称数组。支持通配符。如果任何索引位于远程集群中，则机器学习节点必须具有 remote_cluster_client 角色。
- indices_options（可选，{ allow_no_indices, expand_wildcards, ignore_unavailable, ignore_throttled }）：指定在搜索期间使用的索引扩展选项。
- job_id（可选，字符串）
- max_empty_searches（可选，数字）：如果实时数据馈送从未看到任何数据（包括在任何初始训练期间），则在多次实时搜索返回无文档后，它会自动停止并关闭关联的作业。换句话说，它在实时运行 frequency 乘以 max_empty_searches 次后停止。如果未设置，则没有结束时间且看不到任何数据的数据馈送将保持启动状态，直到被明确停止。默认情况下，它未设置。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：Elasticsearch 查询领域特定语言 (DSL)。此值对应于 Elasticsearch 搜索 POST 正文中的查询对象。Elasticsearch 支持的所有选项都可以使用，因为此对象会逐字传递给 Elasticsearch。请注意，如果更改查询，则分析的数据也会更改。因此，学习所需的时间可能会很长，而且结果的可理解性也不可预测。如果要对源数据进行重大更改，建议您克隆作业和数据馈送，并在克隆中进行修改。让两者并行运行，并在您对作业结果感到满意时关闭其中一个。
- query_delay（可选，字符串 | -1 | 0）：查询数据落后于实时数据的秒数。例如，如果从上午 10:04 开始的数据在上午 10:06 之前可能无法在 Elasticsearch 中搜索，请将此属性设置为 120 秒。默认值在 60s 和 120s 之间随机选择。当同一节点上运行多个作业时，这种随机性可以提高查询性能。
- runtime_mappings（可选，Record<string, { fetch_fields, format, input_field, target_field, target_index, script, type }>）：指定数据馈送搜索的运行时字段。
- script_fields（可选，Record<string, { script, ignore_failure }>）：指定评估自定义表达式并将脚本字段返回到数据馈送的脚本。作业中的检测器配置对象可以包含使用这些脚本字段的函数。
- scroll_size （可选，数字）：当数据馈送不使用聚合时，在 Elasticsearch 搜索中使用的 size 参数。最大值为 index.max_result_window 的值。
- allow_no_indices （可选，布尔值）：如果为 true，则解析为无具体索引的通配符索引表达式将被忽略。这包括 _all 字符串或未指定索引的情况。
- expand_wildcards （可选，枚举（“all” | “open” | “closed” | “hidden” | “none”）| 枚举（“all” | “open” | “closed” | “hidden” | “none”）[]）：通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持值列表。有效值为
all：匹配任何数据流或索引，包括隐藏的。
closed：匹配已关闭的、非隐藏的索引。还匹配任何非隐藏数据流。数据流不能关闭。
hidden：匹配隐藏数据流和隐藏索引。必须与 open、closed 或两者结合使用。
none：不接受通配符模式。
open：匹配已打开的、非隐藏的索引。还匹配任何非隐藏数据流。
- ignore_throttled （可选，布尔值）：如果为 true，则在冻结时忽略具体的、已扩展的或已设置别名的索引。
- ignore_unavailable （可选，布尔值）：如果为 true，则忽略不可用的索引（缺少或已关闭）。

update_filter编辑

更新过滤器的描述，添加项目或删除项目。

端点文档

client.ml.updateFilter({ filter_id })

参数编辑

请求（对象）
- filter_id （字符串）：唯一标识过滤器的字符串。
- add_items （可选，字符串[]）：要添加到过滤器的项目。
- description （可选，字符串）：过滤器的描述。
- remove_items （可选，字符串[]）：要从过滤器中删除的项目。

update_job编辑

更新异常检测作业的某些属性。

端点文档

client.ml.updateJob({ job_id })

参数编辑

请求（对象）
- job_id （字符串）：作业的标识符。
- allow_lazy_open （可选，布尔值）：高级配置选项。指定当机器学习节点容量不足以立即将此作业分配给节点时，此作业是否可以打开。如果为 false 并且无法立即找到具有运行作业能力的机器学习节点，则打开异常检测作业 API 将返回错误。但是，这也受集群范围的 xpack.ml.max_lazy_ml_nodes 设置的限制。如果此选项设置为 true，则打开异常检测作业 API 不会返回错误，并且作业将在打开状态下等待，直到有足够的机器学习节点容量可用。
- analysis_limits （可选，{ model_memory_limit }）
- background_persist_interval （可选，字符串 | -1 | 0）：高级配置选项。模型每次定期持久化之间的时间。默认值是 3 到 4 小时之间的随机值，这避免了所有作业在完全相同的时间持久化。允许的最小值为 1 小时。对于非常大的模型（几 GB），持久化可能需要 10-20 分钟，因此请勿将值设置得太低。如果在进行更新时作业已打开，则必须停止数据馈送，关闭作业，然后重新打开作业并重新启动数据馈送，更改才会生效。
- custom_settings （可选，记录<字符串，用户定义的值>）：高级配置选项。包含有关作业的自定义元数据。例如，它可以包含自定义 URL 信息，如将自定义 URL 添加到机器学习结果中所示。
- categorization_filters （可选，字符串[]）
- description （可选，字符串）：作业的描述。
- model_plot_config （可选，{ annotations_enabled, enabled, terms }）
- model_prune_window （可选，字符串 | -1 | 0）
- daily_model_snapshot_retention_after_days （可选，数字）：高级配置选项，影响此作业的旧模型快照的自动删除。它指定了一段时间（以天为单位），在此之后，每天仅保留第一个快照。此时间段是相对于此作业的最新快照的时间戳的。有效值范围为 0 到 model_snapshot_retention_days。对于在 7.8.0 版本之前创建的作业，默认值与 model_snapshot_retention_days 相匹配。
- model_snapshot_retention_days （可选，数字）：高级配置选项，影响此作业的旧模型快照的自动删除。它指定了保留快照的最长时间段（以天为单位）。此时间段是相对于此作业的最新快照的时间戳的。
- renormalization_window_days （可选，数字）：高级配置选项。在看到新数据时，应用分数调整的时间段。
- results_retention_days （可选，数字）：高级配置选项。保留结果的时间段（以天为单位）。年龄是相对于最新存储桶结果的时间戳计算的。如果此属性具有非空值，则每天一次在 00:30（服务器时间），将从 Elasticsearch 中删除比最新存储桶结果早指定天数的结果。默认值为 null，这意味着将保留所有结果。
- groups（可选，字符串[]）：作业组的列表。一个作业可以不属于任何组，也可以属于多个组。
- detectors （可选，{ by_field_name, custom_rules, detector_description, detector_index, exclude_frequent, field_name, function, over_field_name, partition_field_name, use_null }[]）：检测器更新对象数组。
- per_partition_categorization （可选，{ enabled, stop_on_warn }）：与分类如何与分区字段交互相关的设置。

update_model_snapshot编辑

更新快照的某些属性。

端点文档

client.ml.updateModelSnapshot({ job_id, snapshot_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- snapshot_id （字符串）：模型快照的标识符。
- description （可选，字符串）：模型快照的描述。
- retain （可选，布尔值）：如果为 true，则在自动清除早于 model_snapshot_retention_days 的快照期间，不会删除此快照。但是，删除作业时，将删除此快照。

update_trained_model_deployment编辑

更新训练模型部署的某些属性。

端点文档

client.ml.updateTrainedModelDeployment({ model_id })

参数编辑

请求（对象）
- model_id（字符串）：已训练模型的唯一标识符。目前，仅支持 PyTorch 模型。
- number_of_allocations（可选，数字）：已部署模型的每个节点上的模型分配数量。节点上的所有分配共享内存中模型的相同副本，但使用单独的线程集来评估模型。增加此值通常会提高吞吐量。如果此设置大于硬件线程数，它将自动更改为小于硬件线程数的值。

upgrade_job_snapshot编辑

将给定的作业快照升级到当前主版本。

端点文档

client.ml.upgradeJobSnapshot({ job_id, snapshot_id })

参数编辑

请求（对象）
- job_id （字符串）：异常检测作业的标识符。
- snapshot_id （字符串）：唯一标识模型快照的数字字符串。
- wait_for_completion （可选，布尔值）：如果为 true，则 API 在升级完成之前不会响应。否则，它会在升级任务分配给节点后立即响应。
- timeout （可选，字符串 | -1 | 0）：控制等待请求完成的时间。

monitoring编辑

bulk编辑

供监控功能用于发送监控数据。

端点文档

client.monitoring.bulk({ system_id, system_api_version, interval })

参数编辑

请求（对象）
- system_id （字符串）：被监控系统的标识符
- system_api_version （字符串）
- interval （字符串 | -1 | 0）：有效负载的收集间隔（例如，_10 秒_ 或 _10000 毫秒_）
- type （可选，字符串）：未提供类型的项目的默认文档类型
- operations （可选，{ index, create, update, delete } | { detect_noop, doc, doc_as_upsert, script, scripted_upsert, _source, upsert } | 对象数组）

nodes编辑

clear_repositories_metering_archive编辑

删除集群中存在的已归档存储库计量信息。

端点文档

client.nodes.clearRepositoriesMeteringArchive({ node_id, max_archive_version })

参数编辑

请求（对象）
- node_id（字符串 | 字符串数组）：用于限制返回信息的节点 ID 或名称列表。所有节点选择选项均在此处说明（https://elastic.ac.cn/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes）。
- max_archive_version（数字）：指定要从存档中清除的最大 [archive_version](https://elastic.ac.cn/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html#get-repositories-metering-api-response-body）。

get_repositories_metering_info编辑

返回集群存储库计量信息。

端点文档

client.nodes.getRepositoriesMeteringInfo({ node_id })

参数编辑

请求（对象）
- node_id（字符串 | 字符串数组）：用于限制返回信息的节点 ID 或名称列表。所有节点选择选项均在此处说明（https://elastic.ac.cn/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes）。

hot_threads编辑

返回有关集群中每个节点上的热点线程的信息。

端点文档

client.nodes.hotThreads({ ... })

参数编辑

请求（对象）
- node_id（可选，字符串 | 字符串数组）：用于限制返回信息的节点 ID 或名称列表。
- ignore_idle_threads（可选，布尔值）：如果为 true，则过滤掉已知的空闲线程（例如，在套接字选择中等待或从空队列中获取任务）。
- interval（可选，字符串 | -1 | 0）：执行第二次线程采样的时间间隔。
- snapshots（可选，数字）：线程堆栈跟踪的样本数。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- threads（可选，数字）：指定要为其提供信息的热点线程数。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- type（可选，枚举（“cpu” | “wait” | “block” | “gpu” | “mem”））：要采样的类型。
- sort（可选，枚举（“cpu” | “wait” | “block” | “gpu” | “mem”））：*cpu* 类型的排序顺序（默认值：total）

info编辑

返回有关集群中节点的信息。

端点文档

client.nodes.info({ ... })

参数编辑

请求（对象）
- node_id（可选，字符串 | 字符串数组）：用于限制返回信息的节点 ID 或名称列表。
- metric（可选，字符串 | 字符串数组）：将返回的信息限制为特定的指标。支持列表，例如 http,ingest。
- flat_settings（可选，布尔值）：如果为 true，则以平面格式返回设置。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

reload_secure_settings编辑

重新加载安全设置。

端点文档

client.nodes.reloadSecureSettings({ ... })

参数编辑

请求（对象）
- node_id（可选，字符串 | 字符串数组）：集群中要定位的特定节点的名称。
- secure_settings_password（可选，字符串）：Elasticsearch 密钥库的密码。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

stats编辑

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

端点文档

client.nodes.stats({ ... })

参数编辑

请求（对象）
- node_id（可选，字符串 | 字符串数组）：用于限制返回信息的节点 ID 或名称列表。
- metric （可选，字符串 | 字符串[]）：将返回的信息限制为指定的指标
- index_metric（可选，字符串 | 字符串数组）：将索引指标返回的信息限制为特定的索引指标。仅当指定了索引（或全部）指标时，才能使用它。
- completion_fields（可选，字符串 | 字符串数组）：要包含在字段数据和建议统计信息中的字段的列表或通配符表达式。
- fielddata_fields（可选，字符串 | 字符串数组）：要包含在字段数据统计信息中的字段的列表或通配符表达式。
- fields （可选，字符串 | 字符串[]）：要包含在统计信息中的字段的列表或通配符表达式。
- groups（可选，布尔值）：要包含在搜索统计信息中的搜索组列表。
- include_segment_file_sizes（可选，布尔值）：如果为 true，则调用将报告每个 Lucene 索引文件的聚合磁盘使用情况（仅在请求段统计信息时适用）。
- level（可选，枚举（"cluster" | "indices" | "shards"））：指示是在集群、索引还是分片级别聚合统计信息。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- types（可选，字符串数组）：索引索引指标的文档类型列表。
- include_unloaded_segments（可选，布尔值）：如果为 true，则响应包含来自未加载到内存中的段的信息。

usage编辑

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

端点文档

client.nodes.usage({ ... })

参数编辑

请求（对象）
- node_id（可选，字符串 | 字符串数组）：用于限制返回信息的节点 ID 或名称列表；使用 _local 返回来自您所连接节点的信息，留空以获取来自所有节点的信息
- metric（可选，字符串 | 字符串数组）：将返回的信息限制为特定的指标。以下选项的列表：_all、rest_actions。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

query_ruleset编辑

delete编辑

删除查询规则集。

端点文档

client.queryRuleset.delete({ ruleset_id })

参数编辑

请求（对象）
- ruleset_id（字符串）：要删除的查询规则集的唯一标识符

get编辑

返回有关查询规则集的详细信息。

端点文档

client.queryRuleset.get({ ruleset_id })

参数编辑

请求（对象）
- ruleset_id（字符串）：查询规则集的唯一标识符

list编辑

列出查询规则集。

端点文档

client.queryRuleset.list({ ... })

参数编辑

请求（对象）
- from （可选，数字）：起始偏移量（默认值：0）
- size（可选，数字）：指定要获取的最大结果数

put编辑

创建或更新查询规则集。

端点文档

client.queryRuleset.put({ ruleset_id, rules })

参数编辑

请求（对象）
- ruleset_id（字符串）：要创建或更新的查询规则集的唯一标识符
- rules（{ rule_id, type, criteria, actions }[]）

rollup编辑

delete_job编辑

删除现有的汇总作业。

端点文档

client.rollup.deleteJob({ id })

参数编辑

请求（对象）
- id（字符串）：作业的标识符。

get_jobs编辑

检索汇总作业的配置、统计信息和状态。

端点文档

client.rollup.getJobs({ ... })

参数编辑

请求（对象）
- id（可选，字符串）：汇总作业的标识符。如果它是 _all 或省略，则 API 返回所有汇总作业。

get_rollup_caps编辑

返回已为特定索引或索引模式配置的任何汇总作业的功能。

端点文档

client.rollup.getRollupCaps({ ... })

参数编辑

请求（对象）
- id（可选，字符串）：要返回其汇总功能的索引、索引或索引模式。可以使用 _all 从所有作业中获取汇总功能。

get_rollup_index_caps编辑

返回汇总索引（例如，存储汇总数据的索引）中所有作业的汇总功能。

端点文档

client.rollup.getRollupIndexCaps({ index })

参数编辑

请求（对象）
- index（字符串 | 字符串数组）：要检查其汇总功能的数据流或索引。支持通配符 (*) 表达式。

put_job编辑

创建汇总作业。

端点文档

client.rollup.putJob({ id, cron, groups, index_pattern, page_size, rollup_index })

参数编辑

请求（对象）
- id（字符串）：汇总作业的标识符。这可以是任何字母数字字符串，并且唯一标识与汇总作业关联的数据。该 ID 是持久的；它与汇总数据一起存储。如果您创建了一个作业，让它运行一段时间，然后删除该作业，则该作业汇总的数据仍然与该作业 ID 相关联。您无法使用相同的 ID 创建新作业，因为这可能会导致作业配置不匹配的问题。
- cron（字符串）：一个 cron 字符串，用于定义应执行汇总作业的时间间隔。当时间间隔触发时，索引器会尝试汇总索引模式中的数据。cron 模式与要汇总的数据的时间间隔无关。例如，您可能希望创建文档的每小时汇总，但仅在午夜每天运行一次索引器，如 cron 所定义。cron 模式的定义就像 Watcher cron 计划一样。
- groups（{ date_histogram, histogram, terms }）：定义为此汇总作业定义的分组字段和聚合。然后，这些字段稍后可用于聚合到存储桶中。这些聚合和字段可以任意组合使用。将组配置视为定义一组工具，这些工具稍后可以在聚合中用于对数据进行分区。与原始数据不同，我们必须提前考虑可能使用哪些字段和聚合。汇总提供了足够的灵活性，您只需确定需要哪些字段，而不需要确定它们的顺序。
- index_pattern（字符串）：要汇总的索引或索引模式。支持通配符样式模式 (logstash-*)。该作业会尝试汇总整个索引或索引模式。
- page_size（数字）：在每次滚动索引器迭代中处理的桶结果数。较大的值往往执行速度更快，但在处理过程中需要更多内存。此值不会影响数据的汇总方式；它仅用于调整索引器的速度或内存成本。
- rollup_index（字符串）：包含汇总结果的索引。该索引可以与其他汇总作业共享。数据存储方式不会干扰不相关的作业。
- metrics（可选，{ field, metrics }[]）：定义要为每个分组元组收集的指标。默认情况下，只收集每个组的文档计数。为了使汇总有用，您通常会添加平均值、最小值、最大值等指标。指标是在每个字段的基础上定义的，对于每个字段，您可以配置应该收集哪些指标。
- timeout（可选，字符串 | -1 | 0）：等待请求完成的时间。
- headers（可选，Record<string, string | string[]>）

rollup_searchedit

可以使用标准查询 DSL 搜索汇总数据。

端点文档

client.rollup.rollupSearch({ index })

参数edit

请求（对象）
- index（字符串 | 字符串[]）：可以使用标准查询 DSL 搜索汇总数据。
- aggregations（可选，Record<string, { aggregations, meta, adjacency_matrix, auto_date_histogram, avg, avg_bucket, boxplot, bucket_script, bucket_selector, bucket_sort, bucket_count_ks_test, bucket_correlation, cardinality, categorize_text, children, composite, cumulative_cardinality, cumulative_sum, date_histogram, date_range, derivative, diversified_sampler, extended_stats, extended_stats_bucket, frequent_item_sets, filter, filters, geo_bounds, geo_centroid, geo_distance, geohash_grid, geo_line, geotile_grid, geohex_grid, global, histogram, ip_range, ip_prefix, inference, line, matrix_stats, max, max_bucket, median_absolute_deviation, min, min_bucket, missing, moving_avg, moving_percentiles, moving_fn, multi_terms, nested, normalize, parent, percentile_ranks, percentiles, percentiles_bucket, range, rare_terms, rate, reverse_nested, sampler, scripted_metric, serial_diff, significant_terms, significant_text, stats, stats_bucket, string_stats, sum, sum_bucket, terms, top_hits, t_test, top_metrics, value_count, weighted_avg, variable_width_histogram }>）：指定聚合。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：指定 DSL 查询。
- size（可选，数字）：如果设置，则必须为零，因为汇总在预先聚合的数据上工作。
- rest_total_hits_as_int（可选，布尔值）：指示在 REST 搜索响应中 hits.total 应呈现为整数还是对象
- typed_keys （可选，布尔值）：指定在响应中是否应在其相应类型的聚合器和建议器名称前添加前缀

start_jobedit

启动现有的、已停止的汇总作业。

端点文档

client.rollup.startJob({ id })

参数edit

请求（对象）
- id（字符串）：汇总作业的标识符。

stop_jobedit

停止现有的、已启动的汇总作业。

端点文档

client.rollup.stopJob({ id })

参数edit

请求（对象）
- id（字符串）：汇总作业的标识符。
- timeout（可选，字符串 | -1 | 0）：如果 wait_for_completion 为 true，则 API 在等待作业停止时将阻塞（最多）指定的时间。如果超过了 timeout 时间，则 API 将抛出超时异常。
- wait_for_completion（可选，布尔值）：如果设置为 true，则会导致 API 阻塞，直到索引器状态完全停止。如果设置为 false，则 API 立即返回，并且索引器在后台异步停止。

search_applicationedit

deleteedit

删除搜索应用程序。

端点文档

client.searchApplication.delete({ name })

参数edit

请求（对象）
- name（字符串）：要删除的搜索应用程序的名称

delete_behavioral_analyticsedit

删除行为分析集合。

端点文档

client.searchApplication.deleteBehavioralAnalytics({ name })

参数edit

请求（对象）
- name（字符串）：要删除的分析集合的名称

getedit

返回有关搜索应用程序的详细信息。

端点文档

client.searchApplication.get({ name })

参数edit

请求（对象）
- name（字符串）：搜索应用程序的名称

get_behavioral_analyticsedit

返回现有的行为分析集合。

端点文档

client.searchApplication.getBehavioralAnalytics({ ... })

参数edit

请求（对象）
- name（可选，字符串[]）：分析集合列表，用于限制返回的信息

listedit

返回现有的搜索应用程序。

端点文档

client.searchApplication.list({ ... })

参数edit

请求（对象）
- q （可选，字符串）：使用 Lucene 查询字符串语法的查询。
- from（可选，数字）：起始偏移量。
- size（可选，数字）：指定要获取的最大结果数。

post_behavioral_analytics_eventedit

为现有集合创建行为分析事件。

端点文档

client.searchApplication.postBehavioralAnalyticsEvent()

putedit

创建或更新搜索应用程序。

端点文档

client.searchApplication.put({ name })

参数edit

请求（对象）
- name（字符串）：要创建或更新的搜索应用程序的名称。
- search_application（可选，{ name, indices, updated_at_millis, analytics_collection_name, template }）
- create（可选，布尔值）：如果为 true，则此请求不能替换或更新现有的搜索应用程序。

put_behavioral_analyticsedit

创建行为分析集合。

端点文档

client.searchApplication.putBehavioralAnalytics({ name })

参数edit

请求（对象）
- name（字符串）：要创建或更新的分析集合的名称。

render_queryedit

为给定的搜索应用程序搜索参数呈现查询

端点文档

client.searchApplication.renderQuery()

searchedit

对搜索应用程序执行搜索

端点文档

client.searchApplication.search({ name })

参数edit

请求（对象）
- name（字符串）：要搜索的搜索应用程序的名称。
- params（可选，Record<string, 用户定义的值>）：特定于此请求的查询参数，将覆盖模板中指定的任何默认值。
- typed_keys（可选，布尔值）：确定在响应中聚合名称是否以其各自的类型作为前缀。

searchable_snapshotsedit

cache_statsedit

检索有关可搜索快照的节点级缓存统计信息。

端点文档

client.searchableSnapshots.cacheStats({ ... })

参数edit

请求（对象）
- node_id（可选，字符串 | 字符串数组）：用于限制返回信息的节点 ID 或名称列表；使用 _local 返回来自您所连接节点的信息，留空以获取来自所有节点的信息
- master_timeout（可选，字符串 | -1 | 0）

clear_cacheedit

清除可搜索快照的缓存。

端点文档

client.searchableSnapshots.clearCache({ ... })

参数edit

请求（对象）
- index（可选，字符串 | 字符串[]）：索引名称列表
- expand_wildcards（可选，Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[]）：是否将通配符表达式扩展到打开、关闭或同时打开和关闭的具体索引。
- allow_no_indices （可选，布尔值）：是否忽略通配符索引表达式解析为无具体索引的情况。（这包括 _all 字符串或未指定任何索引时）
- ignore_unavailable （可选，布尔值）：当指定的具体索引不可用（丢失或关闭）时是否应忽略它们
- pretty（可选，布尔值）
- human（可选，布尔值）

mountedit

将快照挂载为可搜索索引。

端点文档

client.searchableSnapshots.mount({ repository, snapshot, index })

参数edit

请求（对象）
- repository（字符串）：包含要挂载的索引快照的存储库的名称
- snapshot（字符串）：要挂载的索引快照的名称
- index（字符串）
- renamed_index（可选，字符串）
- index_settings（可选，Record<string, 用户定义的值>）
- ignore_index_settings（可选，字符串[]）
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时
- wait_for_completion（可选，布尔值）：此请求是否应在操作完成之前返回
- storage（可选，字符串）：选择用于加速搜索的本地存储类型。实验性的，默认为 full_copy

statsedit

检索有关可搜索快照的分片级统计信息。

端点文档

client.searchableSnapshots.stats({ ... })

参数编辑

请求（对象）
- index（可选，字符串 | 字符串[]）：索引名称列表
- level（可选，枚举("cluster" | "indices" | "shards")）：返回在集群、索引或分片级别聚合的统计信息

安全编辑

activate_user_profile编辑

代表另一个用户创建或更新用户配置文件。

端点文档

client.security.activateUserProfile({ grant_type })

参数编辑

请求（对象）
- grant_type（枚举("password" | "access_token")）
- access_token（可选，字符串）
- password（可选，字符串）
- username（可选，字符串）

authenticate编辑

启用以用户身份进行身份验证并检索有关已通过身份验证的用户信息。

端点文档

client.security.authenticate()

bulk_update_api_keys编辑

更新多个现有 API 密钥的属性。

端点文档

client.security.bulkUpdateApiKeys()

change_password编辑

更改本地领域中用户和内置用户的密码。

端点文档

client.security.changePassword({ ... })

参数编辑

请求（对象）
- username（可选，字符串）：要更改其密码的用户。如果未指定此参数，则会更改当前用户的密码。
- password（可选，字符串）：新密码值。密码长度必须至少为 6 个字符。
- password_hash（可选，字符串）：新密码值的哈希值。这必须使用与为密码存储配置的哈希算法相同的算法生成。有关更多详细信息，请参阅xpack.security.authc.password_hashing.algorithm设置的说明。
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

clear_api_key_cache编辑

从 API 密钥缓存中清除一个子集或所有条目。

端点文档

client.security.clearApiKeyCache({ ids })

参数编辑

请求（对象）
- ids（字符串 | 字符串数组）：要从 API 密钥缓存中清除的 API 密钥 ID 列表。要清除所有 API 密钥，请使用*。不支持其他通配符模式。

clear_cached_privileges编辑

从本地应用程序权限缓存中清除应用程序权限。

端点文档

client.security.clearCachedPrivileges({ application })

参数编辑

请求（对象）
- application（字符串）：应用程序名称列表

clear_cached_realms编辑

从用户缓存中清除用户。可以完全清除缓存或清除特定用户。

端点文档

client.security.clearCachedRealms({ realms })

参数编辑

请求（对象）
- realms（字符串 | 字符串数组）：要清除的领域列表
- usernames（可选，字符串数组）：要从缓存中清除的用户名列表

clear_cached_roles编辑

从本地角色缓存中清除角色。

端点文档

client.security.clearCachedRoles({ name })

参数编辑

请求（对象）
- name（字符串 | 字符串数组）：角色名称

clear_cached_service_tokens编辑

从服务帐户令牌缓存中清除令牌。

端点文档

client.security.clearCachedServiceTokens({ namespace, service, name })

参数编辑

请求（对象）
- namespace（字符串）：命名空间的标识符
- service（字符串）：服务名称的标识符
- name（字符串 | 字符串数组）：服务令牌名称列表

create_api_key编辑

创建 API 密钥以进行访问，而无需进行基本身份验证。

端点文档

client.security.createApiKey({ ... })

参数编辑

请求（对象）
- expiration（可选，字符串 | -1 | 0）：API 密钥的到期时间。默认情况下，API 密钥永不过期。
- name（可选，字符串）：指定此 API 密钥的名称。
- role_descriptors（可选，记录<字符串，{ cluster，indices，global，applications，metadata，run_as，transient_metadata }>）：此 API 密钥的角色描述符数组。此参数是可选的。如果未指定或为空数组，则 API 密钥将具有已通过身份验证用户的权限的时间点快照。如果提供角色描述符，则最终权限将是 API 密钥权限和已通过身份验证的用户权限的交集，从而限制 API 密钥的访问范围。角色描述符的结构与创建角色 API 的请求相同。有关更多详细信息，请参阅创建或更新角色 API。
- metadata（可选，记录<字符串，用户定义的值>）：要与 API 密钥关联的任意元数据。它支持嵌套数据结构。在元数据对象中，以_开头的键保留供系统使用。
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

create_cross_cluster_api_key编辑

为基于 API 密钥的远程集群访问创建跨集群 API 密钥。

端点文档

client.security.createCrossClusterApiKey()

create_service_token编辑

创建服务帐户令牌以进行访问，而无需进行基本身份验证。

端点文档

client.security.createServiceToken({ namespace, service })

参数编辑

请求（对象）
- namespace（字符串）：命名空间的标识符
- service（字符串）：服务名称的标识符
- name（可选，字符串）：令牌名称的标识符
- refresh（可选，枚举(true | false | "wait_for")）：如果为true，则刷新受影响的分片以使此操作对搜索可见；如果为wait_for（默认值），则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

delete_privileges编辑

删除应用程序权限。

端点文档

client.security.deletePrivileges({ application, name })

参数编辑

请求（对象）
- application（字符串）：应用程序名称
- name（字符串 | 字符串数组）：权限名称
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

delete_role编辑

删除本地领域中的角色。

端点文档

client.security.deleteRole({ name })

参数编辑

请求（对象）
- name（字符串）：角色名称
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

delete_role_mapping编辑

删除角色映射。

端点文档

client.security.deleteRoleMapping({ name })

参数编辑

请求（对象）
- name（字符串）：角色映射名称
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

delete_service_token编辑

删除服务帐户令牌。

端点文档

client.security.deleteServiceToken({ namespace, service, name })

参数编辑

请求（对象）
- namespace（字符串）：命名空间的标识符
- service（字符串）：服务名称的标识符
- name（字符串）：令牌名称的标识符
- refresh（可选，枚举(true | false | "wait_for")）：如果为true，则刷新受影响的分片以使此操作对搜索可见；如果为wait_for（默认值），则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

delete_user编辑

从本地领域中删除用户。

端点文档

client.security.deleteUser({ username })

参数编辑

请求（对象）
- username（字符串）：用户名
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

disable_user编辑

禁用本地领域中的用户。

端点文档

client.security.disableUser({ username })

参数编辑

请求（对象）
- username（字符串）：要禁用的用户的用户名
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

disable_user_profile编辑

禁用用户配置文件，使其在用户配置文件搜索中不可见。

端点文档

client.security.disableUserProfile({ uid })

参数编辑

请求（对象）
- uid（字符串）：用户配置文件的唯一标识符。
- refresh （可选，枚举（true | false | "wait_for"））：如果为 true，Elasticsearch 会刷新受影响的分片以使此操作对搜索可见；如果为 wait_for，则等待刷新以使此操作对搜索可见；如果为 false，则不对刷新执行任何操作。

enable_user编辑

启用本地领域中的用户。

端点文档

client.security.enableUser({ username })

参数编辑

请求（对象）
- username（字符串）：要启用的用户的用户名
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

enable_user_profile编辑

启用用户配置文件，使其在用户配置文件搜索中可见。

端点文档

client.security.enableUserProfile({ uid })

参数编辑

请求（对象）
- uid（字符串）：用户配置文件的唯一标识符。
- refresh （可选，枚举（true | false | "wait_for"））：如果为 true，Elasticsearch 会刷新受影响的分片以使此操作对搜索可见；如果为 wait_for，则等待刷新以使此操作对搜索可见；如果为 false，则不对刷新执行任何操作。

enroll_kibana编辑

允许 Kibana 实例将自身配置为与安全的 Elasticsearch 集群进行通信。

端点文档

client.security.enrollKibana()

enroll_node编辑

允许将新节点加入启用了安全功能的现有集群。

端点文档

client.security.enrollNode()

get_api_key编辑

检索一个或多个 API 密钥的信息。

端点文档

client.security.getApiKey({ ... })

参数编辑

请求（对象）
- id （可选，字符串）：API 密钥 ID。此参数不能与 name、realm_name 或 username 中的任何一个一起使用。
- name （可选，字符串）：API 密钥名称。此参数不能与 id、realm_name 或 username 中的任何一个一起使用。它支持使用通配符进行前缀搜索。
- owner （可选，布尔值）：一个布尔标志，可用于查询当前已认证用户拥有的 API 密钥。当此参数设置为 true 时，不能指定 realm_name 或 username 参数，因为它们假定为当前已认证的参数。
- realm_name （可选，字符串）：身份验证领域的名称。当 owner 标志设置为 true 时，此参数不能与 id 或 name 中的任何一个一起使用。
- username （可选，字符串）：用户的用户名。当 owner 标志设置为 true 时，此参数不能与 id 或 name 中的任何一个一起使用。
- with_limited_by （可选，布尔值）：返回与 API 密钥关联的所有者用户角色描述符的快照。API 密钥的实际权限是其分配的角色描述符和所有者用户角色描述符的交集。
- active_only （可选，布尔值）：一个布尔标志，可用于查询当前处于活动状态的 API 密钥。如果 API 密钥在查询时既未失效也未过期，则视为活动状态。您可以将其与其他参数（如 owner 或 name）一起指定。如果 active_only 为 false，则响应将同时包含活动的和非活动的（已过期或已失效）密钥。
- with_profile_uid （可选，布尔值）：确定是否还要检索 API 密钥所有者主体的配置文件 UID（如果存在）。

get_builtin_privileges编辑

检索此版本的 Elasticsearch 中可用的集群权限和索引权限的列表。

端点文档

client.security.getBuiltinPrivileges()

get_privileges编辑

检索应用程序权限。

端点文档

client.security.getPrivileges({ ... })

参数编辑

请求（对象）
- application （可选，字符串）：应用程序名称
- name （可选，字符串 | 字符串[]）：权限名称

get_role编辑

检索本机领域中的角色。

端点文档

client.security.getRole({ ... })

参数编辑

请求（对象）
- name （可选，字符串 | 字符串[]）：角色的名称。您可以将多个角色指定为列表。如果您未指定此参数，则 API 将返回有关所有角色的信息。

get_role_mapping编辑

检索角色映射。

端点文档

client.security.getRoleMapping({ ... })

参数编辑

请求（对象）
- name （可选，字符串 | 字符串[]）：标识角色映射的唯一名称。该名称仅用作标识符，以便于通过 API 进行交互；它不会以任何方式影响映射的行为。您可以将多个映射名称指定为列表。如果您未指定此参数，则 API 将返回有关所有角色映射的信息。

get_service_accounts编辑

检索有关服务帐户的信息。

端点文档

client.security.getServiceAccounts({ ... })

参数编辑

请求（对象）
- namespace （可选，字符串）：命名空间的名称。省略此参数可检索有关所有服务帐户的信息。如果您省略此参数，则还必须省略 service 参数。
- service （可选，字符串）：服务名称的名称。省略此参数可检索有关属于指定 namespace 的所有服务帐户的信息。

get_service_credentials编辑

检索服务帐户的所有服务凭据的信息。

端点文档

client.security.getServiceCredentials({ namespace, service })

参数编辑

请求（对象）
- namespace （字符串）：命名空间的名称。
- service （字符串）：服务名称的名称。

get_settings编辑

检索安全系统索引的设置

端点文档

client.security.getSettings()

get_token编辑

创建承载令牌，以便在不需要基本身份验证的情况下进行访问。

端点文档

client.security.getToken({ ... })

参数编辑

请求（对象）
- grant_type （可选，枚举（“password” | “client_credentials” | “_kerberos” | “refresh_token”））
- scope （可选，字符串）
- password（可选，字符串）
- kerberos_ticket （可选，字符串）
- refresh_token （可选，字符串）
- username（可选，字符串）

get_user编辑

检索有关本机领域中的用户和内置用户的信息。

端点文档

client.security.getUser({ ... })

参数编辑

请求（对象）
- username （可选，字符串 | 字符串[]）：用户的标识符。您可以将多个用户名指定为列表。如果您省略此参数，则 API 将检索有关所有用户的信息。
- with_profile_uid （可选，布尔值）：如果为 true，则将返回用户的用户配置文件 ID（如果有）。

get_user_privileges编辑

检索登录用户的安全权限。

端点文档

client.security.getUserPrivileges({ ... })

参数编辑

请求（对象）
- application （可选，字符串）：应用程序的名称。应用程序权限始终与一个应用程序关联。如果您未指定此参数，则 API 将返回有关所有应用程序的所有权限的信息。
- priviledge （可选，字符串）：权限的名称。如果您未指定此参数，则 API 将返回有关所请求应用程序的所有权限的信息。
- username （可选，字符串 | null）

get_user_profile编辑

检索给定唯一 ID 的用户配置文件。

端点文档

client.security.getUserProfile({ uid })

参数编辑

请求（对象）
- uid （字符串 | 字符串[]）：用户配置文件的唯一标识符。
- data （可选，字符串 | 字符串[]）：配置文件文档的 data 字段的过滤器列表。要返回所有内容，请使用 data=*。要返回内容的子集，请使用 data=<key> 检索指定 <key> 下嵌套的内容。默认情况下，不返回 data 内容。

grant_api_key编辑

代表另一个用户创建 API 密钥。

端点文档

client.security.grantApiKey({ api_key, grant_type })

参数编辑

请求（对象）
- api_key （{ name, expiration, role_descriptors, metadata }）：定义 API 密钥。
- grant_type （枚举（“access_token” | “password”））：授权类型。支持的授权类型有：access_token、password。
- access_token （可选，字符串）：用户的访问令牌。如果您指定 access_token 授权类型，则此参数是必需的。它对其他授权类型无效。
- username （可选，字符串）：标识用户的用户名。如果您指定 password 授权类型，则此参数是必需的。它对其他授权类型无效。
- password （可选，字符串）：用户的密码。如果您指定 password 授权类型，则此参数是必需的。它对其他授权类型无效。
- run_as （可选，字符串）：要模拟的用户的名称。

has_privileges编辑

确定指定的用户是否具有指定的权限列表。

端点文档

client.security.hasPrivileges({ ... })

参数编辑

请求（对象）
- user （可选，字符串）：用户名
- application （可选，{ application, privileges, resources }[]）
- cluster （可选，Enum("all" | "cancel_task" | "create_snapshot" | "cross_cluster_replication" | "cross_cluster_search" | "delegate_pki" | "grant_api_key" | "manage" | "manage_api_key" | "manage_autoscaling" | "manage_behavioral_analytics" | "manage_ccr" | "manage_data_frame_transforms" | "manage_data_stream_global_retention" | "manage_enrich" | "manage_ilm" | "manage_index_templates" | "manage_inference" | "manage_ingest_pipelines" | "manage_logstash_pipelines" | "manage_ml" | "manage_oidc" | "manage_own_api_key" | "manage_pipeline" | "manage_rollup" | "manage_saml" | "manage_search_application" | "manage_search_query_rules" | "manage_search_synonyms" | "manage_security" | "manage_service_account" | "manage_slm" | "manage_token" | "manage_transform" | "manage_user_profile" | "manage_watcher" | "monitor" | "monitor_data_frame_transforms" | "monitor_data_stream_global_retention" | "monitor_enrich" | "monitor_inference" | "monitor_ml" | "monitor_rollup" | "monitor_snapshot" | "monitor_text_structure" | "monitor_transform" | "monitor_watcher" | "none" | "post_behavioral_analytics_event" | "read_ccr" | "read_connector_secrets" | "read_fleet_secrets" | "read_ilm" | "read_pipeline" | "read_security" | "read_slm" | "transport_client" | "write_connector_secrets" | "write_fleet_secrets")[])：要检查的集群权限列表。
- index （可选，{ names, privileges, allow_restricted_indices }[])

has_privileges_user_profile编辑

确定与指定的配置文件 ID 关联的用户是否具有所有请求的权限。

端点文档

client.security.hasPrivilegesUserProfile({ uids, privileges })

参数编辑

请求（对象）
- uids (string[])：配置文件 ID 列表。将检查与配置文件关联的用户的权限。
- privileges ({ application, cluster, index })

invalidate_api_key编辑

使一个或多个 API 密钥失效。

端点文档

client.security.invalidateApiKey({ ... })

参数编辑

请求（对象）
- id (可选，字符串)
- ids （可选，string[]）：API 密钥 ID 列表。此参数不能与任何 name、realm_name 或 username 一起使用。
- name （可选，字符串）：API 密钥名称。此参数不能与任何 ids、realm_name 或 username 一起使用。
- owner （可选，布尔值）：可用于查询当前经过身份验证的用户拥有的 API 密钥。将此参数设置为 true 时，不能指定 realm_name 或 username 参数，因为它们被假定为当前经过身份验证的参数。
- realm_name （可选，字符串）：身份验证领域的名称。当 owner 标志设置为 true 时，此参数不能与 ids 或 name 一起使用。
- username （可选，字符串）：用户的用户名。当 owner 标志设置为 true 时，此参数不能与 ids 或 name 一起使用。

invalidate_token编辑

使一个或多个访问令牌或刷新令牌失效。

端点文档

client.security.invalidateToken({ ... })

参数编辑

请求（对象）
- token (可选，字符串)
- refresh_token （可选，字符串）
- realm_name (可选，字符串)
- username（可选，字符串）

oidc_authenticate编辑

将 OpenID Connect 身份验证响应消息交换为 Elasticsearch 访问令牌和刷新令牌对

端点文档

client.security.oidcAuthenticate()

oidc_logout编辑

使从 OpenID Connect 身份验证 API 生成的刷新令牌和访问令牌失效

端点文档

client.security.oidcLogout()

oidc_prepare_authentication编辑

创建 OAuth 2.0 身份验证请求作为 URL 字符串

端点文档

client.security.oidcPrepareAuthentication()

put_privileges编辑

添加或更新应用程序权限。

端点文档

client.security.putPrivileges({ ... })

参数编辑

请求（对象）
- privileges （可选，Record<string, Record<string, 用户定义的值>>)
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

put_role编辑

在本地领域中添加和更新角色。

端点文档

client.security.putRole({ name })

参数编辑

请求（对象）
- name (string)：角色的名称。
- applications （可选，{ application, privileges, resources }[]）：应用程序权限条目列表。
- cluster （可选，Enum("all" | "cancel_task" | "create_snapshot" | "cross_cluster_replication" | "cross_cluster_search" | "delegate_pki" | "grant_api_key" | "manage" | "manage_api_key" | "manage_autoscaling" | "manage_behavioral_analytics" | "manage_ccr" | "manage_data_frame_transforms" | "manage_data_stream_global_retention" | "manage_enrich" | "manage_ilm" | "manage_index_templates" | "manage_inference" | "manage_ingest_pipelines" | "manage_logstash_pipelines" | "manage_ml" | "manage_oidc" | "manage_own_api_key" | "manage_pipeline" | "manage_rollup" | "manage_saml" | "manage_search_application" | "manage_search_query_rules" | "manage_search_synonyms" | "manage_security" | "manage_service_account" | "manage_slm" | "manage_token" | "manage_transform" | "manage_user_profile" | "manage_watcher" | "monitor" | "monitor_data_frame_transforms" | "monitor_data_stream_global_retention" | "monitor_enrich" | "monitor_inference" | "monitor_ml" | "monitor_rollup" | "monitor_snapshot" | "monitor_text_structure" | "monitor_transform" | "monitor_watcher" | "none" | "post_behavioral_analytics_event" | "read_ccr" | "read_connector_secrets" | "read_fleet_secrets" | "read_ilm" | "read_pipeline" | "read_security" | "read_slm" | "transport_client" | "write_connector_secrets" | "write_fleet_secrets")[])：集群权限列表。这些权限定义了具有此角色的用户的集群级操作。
- global （可选，Record<string, 用户定义的值>）：定义全局权限的对象。全局权限是一种请求感知形式的集群权限。对全局权限的支持目前仅限于应用程序权限的管理。
- indices （可选，{ field_security, names, privileges, query, allow_restricted_indices }[]）：索引权限条目列表。
- metadata （可选，Record<string, 用户定义的值>）：可选元数据。在元数据对象中，以下划线 (_) 开头的键保留供系统使用。
- run_as （可选，string[]）：此角色的所有者可以模拟的用户列表。
- transient_metadata （可选，Record<string, 用户定义的值>）：指示可能与当前集群许可证不兼容的角色，特别是具有文档和字段级安全性的角色。当集群许可证不允许对给定角色使用某些功能时，此参数会动态更新以列出不兼容的功能。如果 enabled 为 false，则该角色将被忽略，但仍会在 authenticate API 的响应中列出。
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

put_role_mapping编辑

创建和更新角色映射。

端点文档

client.security.putRoleMapping({ name })

参数编辑

请求（对象）
- name（字符串）：角色映射名称
- enabled （可选，布尔值）
- metadata （可选，Record<string, 用户定义的值>)
- roles （可选，string[]）
- role_templates （可选，{ format, template }[])
- rules （可选，{ any, all, field, except })
- run_as （可选，string[]）
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

put_user编辑

在本地领域中添加和更新用户。这些用户通常称为本地用户。

端点文档

client.security.putUser({ username })

参数编辑

请求（对象）
- username (string)：用户的用户名
- email （可选，字符串 | null）
- full_name （可选，字符串 | null）
- metadata （可选，Record<string, 用户定义的值>)
- password（可选，字符串）
- password_hash （可选，字符串）
- roles （可选，string[]）
- enabled （可选，布尔值）
- refresh（可选，枚举(true | false | "wait_for")）：如果为true（默认值），则刷新受影响的分片以使此操作对搜索可见；如果为wait_for，则等待刷新以使此操作对搜索可见；如果为false，则不对刷新执行任何操作。

query_api_keys编辑

使用查询 DSL 的子集检索 API 密钥的信息

端点文档

client.security.queryApiKeys({ ... })

参数编辑

请求（对象）
- aggregations （可选，Record<string, { aggregations, meta, cardinality, composite, date_range, filter, filters, missing, range, terms, value_count }>）：要在返回的 API 密钥语料库上运行的任何聚合。聚合和查询一起工作。聚合仅针对与查询匹配的 API 密钥进行计算。这仅支持一部分聚合类型，即：terms、range、date_range、missing、cardinality、value_count、composite、filter 和 filters。此外，聚合仅在查询工作的相同字段子集上运行。
- query （可选，{ bool, exists, ids, match, match_all, prefix, range, simple_query_string, term, terms, wildcard }）：用于过滤要返回哪些 API 密钥的查询。如果缺少 query 参数，则等同于 match_all 查询。该查询支持一部分查询类型，包括 match_all、bool、term、terms、match、ids、prefix、wildcard、exists、range 和 simple_query_string。您可以查询与 API 密钥关联的以下公共信息：id、type、name、creation、expiration、invalidated、invalidation、username、realm 和 metadata。
- from （可选，数字）：起始文档偏移量。默认情况下，您不能使用 from 和 size 参数翻阅超过 10,000 个匹配项。要翻阅更多匹配项，请使用 search_after 参数。
- sort （可选，字符串 | { _score, _doc, _geo_distance, _script } | 字符串 | { _score, _doc, _geo_distance, _script }[]）：除了 id 之外，API 密钥的所有公共字段都可用于排序。此外，排序也可以应用于 _doc 字段以按索引顺序排序。
- size（可选，数字）：要返回的匹配结果数。默认情况下，您无法使用 from 和 size 参数对超过 10,000 个匹配结果进行分页。要对更多匹配结果进行分页，请使用 search_after 参数。
- search_after （可选，数字 | 数字 | 字符串 | 布尔值 | null | 用户定义的值[]）：搜索后定义
- with_limited_by （可选，布尔值）：返回与 API 密钥关联的所有者用户角色描述符的快照。API 密钥的实际权限是其分配的角色描述符和所有者用户角色描述符的交集。
- with_profile_uid （可选，布尔值）：确定是否还要检索 API 密钥所有者主体的配置文件 UID（如果存在）。
- typed_keys（可选，布尔值）：确定在响应中聚合名称是否以其各自的类型作为前缀。

query_user编辑

使用查询 DSL 的子集检索用户信息

端点文档

client.security.queryUser()

saml_authenticate编辑

将 SAML 响应消息交换为 Elasticsearch 访问令牌和刷新令牌对

端点文档

client.security.samlAuthenticate({ content, ids })

参数编辑

请求（对象）
- content (string): 用户浏览器发送的 SAML 响应，通常是 Base64 编码的 XML 文档。
- ids (string | string[]): 一个 JSON 数组，包含 API 调用者为当前用户拥有的所有有效 SAML 请求 ID。
- realm (可选, string): 应该对 SAML 响应进行身份验证的领域名称。在定义了许多 SAML 领域的情况下很有用。

saml_complete_logout编辑

验证从 SAML IdP 发送的注销响应

端点文档

client.security.samlCompleteLogout({ realm, ids })

参数编辑

请求（对象）
- realm (string): Elasticsearch 中 SAML 领域的名称，其配置用于验证注销响应。
- ids (string | string[]): 一个 JSON 数组，包含 API 调用者为当前用户拥有的所有有效 SAML 请求 ID。
- query_string (可选, string): 如果 SAML IdP 使用 HTTP-Redirect 绑定发送注销响应，则必须将此字段设置为重定向 URI 的查询字符串。
- content (可选, string): 如果 SAML IdP 使用 HTTP-Post 绑定发送注销响应，则必须将此字段设置为注销响应中 SAMLResponse 表单参数的值。

saml_invalidate编辑

使用 SAML LogoutRequest

端点文档

client.security.samlInvalidate({ query_string })

参数编辑

请求（对象）
- query_string (string): 用户被 SAML IdP 重定向到的 URL 的查询部分，用于启动单点注销。此查询应包含一个名为 SAMLRequest 的参数，该参数包含一个已压缩并经过 Base64 编码的 SAML 注销请求。如果 SAML IdP 已对注销请求进行签名，则 URL 应包含两个名为 SigAlg 和 Signature 的额外参数，它们分别包含用于签名的算法和签名值本身。为了使 Elasticsearch 能够验证 IdP 的签名，query_string 字段的值必须与浏览器提供的字符串完全匹配。客户端应用程序不得以任何方式尝试解析或处理字符串。
- acs (可选, string): 断言使用者服务 URL，与 Elasticsearch 中应使用的 SAML 领域之一的 URL 相匹配。必须指定此参数或 realm 参数。
- realm (可选, string): Elasticsearch 中 SAML 领域配置的名称。必须指定此参数或 acs 参数。

saml_logout编辑

使通过 SAML 身份验证 API 生成的访问令牌和刷新令牌无效

端点文档

client.security.samlLogout({ token })

参数编辑

请求（对象）
- token (string): 调用 SAML 身份验证 API 后作为响应返回的访问令牌。或者，使用 refresh_token 刷新原始令牌后收到的最新令牌。
- refresh_token (可选, string): 调用 SAML 身份验证 API 后作为响应返回的刷新令牌。或者，在刷新原始访问令牌后收到的最新刷新令牌。

saml_prepare_authentication编辑

创建 SAML 身份验证请求

端点文档

client.security.samlPrepareAuthentication({ ... })

参数编辑

请求（对象）
- acs (可选, string): 断言使用者服务 URL，与 Elasticsearch 中的某个 SAML 领域相匹配。该领域用于生成身份验证请求。必须指定此参数或 realm 参数。
- realm (可选, string): Elasticsearch 中 SAML 领域的名称，其配置用于生成身份验证请求。必须指定此参数或 acs 参数。
- relay_state (可选, string): 将包含在此 API 返回的重定向 URL 中的字符串，作为 RelayState 查询参数。如果身份验证请求已签名，则此值将用作签名计算的一部分。

saml_service_provider_metadata编辑

为 Elastic Stack SAML 2.0 服务提供程序生成 SAML 元数据

端点文档

client.security.samlServiceProviderMetadata({ realm_name })

参数编辑

请求（对象）
- realm_name (string): Elasticsearch 中 SAML 领域的名称。

suggest_user_profiles编辑

获取与指定搜索条件匹配的用户资料建议。

端点文档

client.security.suggestUserProfiles({ ... })

参数编辑

请求（对象）
- name (可选, string): 用于匹配用户资料文档中与姓名相关的字段的查询字符串。与姓名相关的字段是用户的 username、full_name 和 email。
- size (可选, number): 要返回的资料数量。
- data （可选，字符串 | 字符串[]）：配置文件文档的 data 字段的过滤器列表。要返回所有内容，请使用 data=*。要返回内容的子集，请使用 data=<key> 检索指定 <key> 下嵌套的内容。默认情况下，不返回 data 内容。
- hint (可选, { uids, labels }): 额外的搜索条件，用于提高建议结果的相关性。匹配指定提示的资料在响应中排名较高。只要资料与 name 字段查询匹配，不匹配提示的资料就不会从响应中排除。

update_api_key编辑

更新现有 API 密钥的属性。

端点文档

client.security.updateApiKey({ id })

参数编辑

请求（对象）
- id (string): 要更新的 API 密钥的 ID。
- role_descriptors（可选，记录<字符串，{ cluster，indices，global，applications，metadata，run_as，transient_metadata }>）：此 API 密钥的角色描述符数组。此参数是可选的。如果未指定或为空数组，则 API 密钥将具有已通过身份验证用户的权限的时间点快照。如果提供角色描述符，则最终权限将是 API 密钥权限和已通过身份验证的用户权限的交集，从而限制 API 密钥的访问范围。角色描述符的结构与创建角色 API 的请求相同。有关更多详细信息，请参阅创建或更新角色 API。
- metadata (可选, Record<string, User-defined value>): 要与 API 密钥关联的任意元数据。它支持嵌套数据结构。在 metadata 对象中，以下划线 (_) 开头的键保留供系统使用。
- expiration (可选, string | -1 | 0): API 密钥的过期时间。

update_cross_cluster_api_key编辑

更新现有跨集群 API 密钥的属性。

端点文档

client.security.updateCrossClusterApiKey()

update_settings编辑

更新安全系统索引的设置

端点文档

client.security.updateSettings()

update_user_profile_data编辑

更新给定唯一 ID 的用户资料的应用程序特定数据。

端点文档

client.security.updateUserProfileData({ uid })

参数编辑

请求（对象）
- uid (string): 用户资料的唯一标识符。
- labels (可选, Record<string, User-defined value>): 要与用户资料关联的可搜索数据。此字段支持嵌套数据结构。
- data (可选, Record<string, User-defined value>): 要与用户资料关联的不可搜索数据。此字段支持嵌套数据结构。
- if_seq_no （可选，数字）：仅当文档具有此序列号时才执行操作。
- if_primary_term （可选，数字）：仅当文档具有此主期限时才执行操作。
- refresh （可选，枚举（true | false | "wait_for"））：如果为 true，Elasticsearch 会刷新受影响的分片以使此操作对搜索可见；如果为 wait_for，则等待刷新以使此操作对搜索可见；如果为 false，则不对刷新执行任何操作。

shutdown编辑

delete_node编辑

从关闭列表中移除节点。专为 ECE/ESS 和 ECK 间接使用而设计。不支持直接使用。

端点文档

client.shutdown.deleteNode({ node_id })

参数编辑

请求（对象）
- node_id (string): 要从关闭状态中移除的节点的节点 ID
- master_timeout (可选, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d")): 等待连接到主节点的时间。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout (可选, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d")): 等待响应的时间。如果在超时到期之前没有收到响应，则请求失败并返回错误。

get_node编辑

检索当前标记为正在关闭的节点的状态。专为 ECE/ESS 和 ECK 间接使用而设计。不支持直接使用。

端点文档

client.shutdown.getNode({ ... })

参数编辑

请求（对象）
- node_id (可选, string | string[]): 要为其检索关闭状态的节点
- master_timeout (可选, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d")): 等待连接到主节点的时间。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout (可选, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d")): 等待响应的时间。如果在超时到期之前没有收到响应，则请求失败并返回错误。

put_node编辑

添加要关闭的节点。专为 ECE/ESS 和 ECK 间接使用而设计。不支持直接使用。

端点文档

client.shutdown.putNode({ node_id, type, reason })

参数编辑

请求（对象）
- node_id（字符串）：要关闭的节点的节点 ID
- type（枚举（“restart” | “remove” | “replace”））：有效值为 restart、remove 或 replace。当您需要临时关闭节点以执行升级、进行配置更改或执行其他维护时，请使用 restart。由于预计节点将重新加入集群，因此不会将数据从节点中迁移出去。当您需要从集群中永久删除节点时，请使用 remove。在将数据从节点迁移出去之前，该节点不会被标记为准备好关闭。使用 replace 以 1:1 的方式将一个节点替换为另一个节点。为了将源节点真正替换为目标节点，将忽略某些分配决策（例如磁盘水印）。在 replace 类型的关闭期间，滚动和索引创建可能会导致未分配的分片，并且在替换完成之前收缩可能会失败。
- reason（字符串）：节点关闭的可读原因。此字段为其他集群操作员提供信息；它不影响关闭过程。
- allocation_delay（可选，字符串）：仅当 type 为 restart 时有效。控制 Elasticsearch 在将分片重新分配给其他节点之前等待节点重启并加入集群的时间。这与使用 index.unassigned.node_left.delayed_timeout 设置延迟分配的工作原理相同。如果您同时指定了重启分配延迟和索引级分配延迟，则使用两者中较长的时间。
- target_node_name（可选，字符串）：仅当 type 为 replace 时有效。指定正在替换的节点的节点名称。关闭节点中的分片只允许分配给目标节点，并且不会将其他数据分配给目标节点。在数据重新定位期间，某些分配规则将被忽略，例如磁盘水印或用户属性过滤规则。
- master_timeout (可选, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d")): 等待连接到主节点的时间。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout (可选, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d")): 等待响应的时间。如果在超时到期之前没有收到响应，则请求失败并返回错误。

模拟编辑

摄取编辑

使用示例文档模拟运行摄取。

端点文档

client.simulate.ingest()

SLM编辑

delete_lifecycle编辑

删除现有的快照生命周期策略。

端点文档

client.slm.deleteLifecycle({ policy_id })

参数编辑

请求（对象）
- policy_id（字符串）：要删除的快照生命周期策略的 ID

execute_lifecycle编辑

根据生命周期策略立即创建快照，无需等待预定时间。

端点文档

client.slm.executeLifecycle({ policy_id })

参数编辑

请求（对象）
- policy_id（字符串）：要执行的快照生命周期策略的 ID

execute_retention编辑

根据策略的保留规则删除任何过期的快照。

端点文档

client.slm.executeRetention()

get_lifecycle编辑

检索一个或多个快照生命周期策略定义以及有关最新快照尝试的信息。

端点文档

client.slm.getLifecycle({ ... })

参数编辑

请求（对象）
- policy_id（可选，字符串 | 字符串 []）：要检索的快照生命周期策略列表

get_stats编辑

返回有关快照生命周期管理所采取操作的全局和策略级统计信息。

端点文档

client.slm.getStats()

get_status编辑

检索快照生命周期管理 (SLM) 的状态。

端点文档

client.slm.getStatus()

put_lifecycle编辑

创建或更新快照生命周期策略。

端点文档

client.slm.putLifecycle({ policy_id })

参数编辑

请求（对象）
- policy_id（字符串）：要创建或更新的快照生命周期策略的 ID。
- config（可选，{ ignore_unavailable、indices、include_global_state、feature_states、metadata、partial }）：策略创建的每个快照的配置。
- name（可选，字符串）：自动分配给策略创建的每个快照的名称。支持日期数学。为了防止快照名称冲突，会自动将 UUID 附加到每个快照名称。
- repository（可选，字符串）：用于存储此策略创建的快照的存储库。此存储库必须在策略创建之前存在。您可以使用快照存储库 API 创建存储库。
- retention（可选，{ expire_after、max_count、min_count }）：用于保留和删除策略创建的快照的保留规则。
- schedule（可选，字符串）：策略创建快照的定期或绝对计划。SLM 会立即应用计划更改。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

开始编辑

启用快照生命周期管理 (SLM)。

端点文档

client.slm.start()

停止编辑

关闭快照生命周期管理 (SLM)。

端点文档

client.slm.stop()

快照编辑

cleanup_repository编辑

从存储库中删除过时的数据。

端点文档

client.snapshot.cleanupRepository({ repository })

参数编辑

请求（对象）
- repository（字符串）：要清理的快照存储库。
- master_timeout（可选，字符串 | -1 | 0）：等待连接到主节点的时间。
- timeout（可选，字符串 | -1 | 0）：等待响应的时间。

克隆编辑

将索引从一个快照克隆到同一个存储库中的另一个快照。

端点文档

client.snapshot.clone({ repository, snapshot, target_snapshot, indices })

参数编辑

请求（对象）
- repository（字符串）：存储库名称
- snapshot（字符串）：要克隆的快照的名称
- target_snapshot（字符串）：要创建的克隆快照的名称
- indices（字符串）
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时
- timeout（可选，字符串 | -1 | 0）

创建编辑

在存储库中创建快照。

端点文档

client.snapshot.create({ repository, snapshot })

参数编辑

请求（对象）
- repository（字符串）：快照的存储库。
- snapshot（字符串）：快照的名称。在存储库中必须是唯一的。
- ignore_unavailable（可选，布尔值）：如果为 true，则请求会忽略 indices 中缺少或已关闭的数据流和索引。如果为 false，则请求会针对任何缺少或已关闭的数据流或索引返回错误。
- include_global_state（可选，布尔值）：如果为 true，则当前集群状态将包含在快照中。集群状态包括持久集群设置、可组合索引模板、旧索引模板、摄取管道和 ILM 策略。它还包括存储在系统索引中的数据，例如监视和任务记录（可通过 feature_states 配置）。
- indices（可选，字符串 | 字符串 []）：要包含在快照中的数据流和索引。支持多目标语法。默认情况下包含所有数据流和索引。
- feature_states（可选，字符串 []）：要包含在快照中的功能状态。每个功能状态都包含一个或多个包含相关数据的系统索引。您可以使用 get features API 查看符合条件的功能列表。如果 include_global_state 为 true，则默认情况下会包含所有当前功能状态。如果 include_global_state 为 false，则默认情况下不包含任何功能状态。
- metadata（可选，记录<字符串，用户定义的值>）：快照的可选元数据。可以有任何内容。必须小于 1024 字节。此映射不是由 Elasticsearch 自动生成的。
- partial（可选，布尔值）：如果为 true，则允许恢复具有不可用分片的索引的部分快照。只有成功包含在快照中的分片才会被恢复。所有缺少的分片都将重新创建为空。如果为 false，则如果快照中包含的一个或多个索引没有所有可用的主分片，则整个恢复操作都将失败。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_completion（可选，布尔值）：如果为 true，则请求在快照完成后返回响应。如果为 false，则请求在快照初始化时返回响应。

create_repository编辑

创建存储库。

端点文档

client.snapshot.createRepository({ repository })

参数编辑

请求（对象）
- repository（字符串）：存储库名称
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时
- timeout （可选，字符串 | -1 | 0）：显式操作超时
- verify（可选，布尔值）：是否在创建后验证存储库

delete编辑

删除一个或多个快照。

端点文档

client.snapshot.delete({ repository, snapshot })

参数编辑

请求（对象）
- repository（字符串）：存储库名称
- snapshot（字符串）：快照名称列表
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时

delete_repository编辑

删除存储库。

端点文档

client.snapshot.deleteRepository({ repository })

参数编辑

请求（对象）
- repository（字符串 | 字符串数组）：要取消注册的快照存储库的名称。支持通配符 (*) 模式。
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时
- timeout （可选，字符串 | -1 | 0）：显式操作超时

get编辑

返回有关快照的信息。

端点文档

client.snapshot.get({ repository, snapshot })

参数编辑

请求（对象）
- repository（字符串）：用于限制请求的快照存储库名称列表。支持通配符 (*) 表达式。
- snapshot（字符串 | 字符串数组）：要检索的快照名称列表。也接受通配符 (*)。
  - 要获取已注册存储库中所有快照的信息，请使用通配符 (*) 或 _all。
  - 要获取有关当前正在运行的任何快照的信息，请使用 _current。
- ignore_unavailable（可选，布尔值）：如果为 false，则请求将为任何不可用的快照返回错误。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- verbose（可选，布尔值）：如果为 true，则返回有关每个快照的附加信息，例如创建快照的 Elasticsearch 版本、快照的开始和结束时间以及快照的分片数量。
- index_details（可选，布尔值）：如果为 true，则返回有关快照中每个索引的附加信息，包括索引中的分片数量、索引的总大小（以字节为单位）以及索引中每个分片的最大段数。默认为 false，表示省略此信息。
- index_names（可选，布尔值）：如果为 true，则返回每个快照中每个索引的名称。
- include_repository（可选，布尔值）：如果为 true，则返回每个快照中的存储库名称。
- sort（可选，枚举（“start_time” | “duration” | “name” | “index_count” | “repository” | “shard_count” | “failed_shard_count”））：允许为结果设置排序顺序。默认为 start_time，即按快照开始时间戳排序。
- size（可选，数字）：要返回的最大快照数。默认为 0，表示返回所有匹配请求的快照，不受限制。
- order（可选，枚举（“asc” | “desc”））：排序顺序。有效值为 asc（升序）和 desc（降序）。默认为 asc，表示升序。
- after（可选，字符串）：从响应正文中的 next 字段返回的偏移量标识符，用于开始分页。
- offset（可选，数字）：基于与此请求匹配的快照，从该数字偏移量开始分页。为此参数使用非零值与使用 after 参数互斥。默认为 0。
- from_sort_value（可选，字符串）：当前排序列的值，用于开始检索。按快照或存储库名称排序时，可以是字符串快照或存储库名称；按索引或分片计数排序时，可以是毫秒时间值或数字。
- slm_policy_filter（可选，字符串）：按快照所属的 SLM 策略名称列表过滤快照。也接受通配符 (*) 以及通配符后跟以 - 开头的排除模式的组合。要包含未由 SLM 策略创建的快照，可以使用特殊模式 _none，它将匹配没有 SLM 策略的所有快照。

get_repository编辑

返回有关存储库的信息。

端点文档

client.snapshot.getRepository({ ... })

参数编辑

请求（对象）
- repository（可选，字符串 | 字符串数组）：存储库名称列表
- local （可选，布尔值）：返回本地信息，不从主节点检索状态（默认值：false）
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时

repository_analyze编辑

分析存储库的正确性和性能

端点文档

client.snapshot.repositoryAnalyze()

restore编辑

还原快照。

端点文档

client.snapshot.restore({ repository, snapshot })

参数编辑

请求（对象）
- repository（字符串）：存储库名称
- snapshot（字符串）：快照名称
- feature_states（可选，字符串数组）
- ignore_index_settings（可选，字符串[]）
- ignore_unavailable（可选，布尔值）
- include_aliases（可选，布尔值）
- include_global_state（可选，布尔值）
- index_settings（可选，{ index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store }）
- indices（可选，字符串 | 字符串数组）
- partial（可选，布尔值）
- rename_pattern（可选，字符串）
- rename_replacement（可选，字符串）
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时
- wait_for_completion（可选，布尔值）：此请求是否应在操作完成之前返回

status编辑

返回有关快照状态的信息。

端点文档

client.snapshot.status({ ... })

参数编辑

请求（对象）
- repository（可选，字符串）：存储库名称
- snapshot（可选，字符串 | 字符串数组）：快照名称列表
- ignore_unavailable（可选，布尔值）：是否忽略不可用的快照，默认为 false，表示抛出 SnapshotMissingException
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时

verify_repository编辑

验证存储库。

端点文档

client.snapshot.verifyRepository({ repository })

参数编辑

请求（对象）
- repository（字符串）：存储库名称
- master_timeout （可选，字符串 | -1 | 0）：连接到主节点的显式操作超时
- timeout （可选，字符串 | -1 | 0）：显式操作超时

sql编辑

clear_cursor编辑

清除 SQL 游标

端点文档

client.sql.clearCursor({ cursor })

参数编辑

请求（对象）
- cursor（字符串）：要清除的游标。

delete_async编辑

删除异步 SQL 搜索或存储的同步 SQL 搜索。如果搜索仍在运行，则 API 会将其取消。

端点文档

client.sql.deleteAsync({ id })

参数编辑

请求（对象）
- id（字符串）：搜索的标识符。

get_async编辑

返回异步 SQL 搜索或存储的同步 SQL 搜索的当前状态和可用结果

端点文档

client.sql.getAsync({ id })

参数编辑

请求（对象）
- id（字符串）：搜索的标识符。
- delimiter（可选，字符串）：CSV 结果的分隔符。API 仅支持 CSV 响应的此参数。
- format（可选，字符串）：响应的格式。您必须使用此参数或 Accept HTTP 标头指定格式。如果同时指定两者，则 API 将使用此参数。
- keep_alive（可选，字符串 | -1 | 0）：搜索及其结果的保留期。默认为原始 SQL 搜索的 keep_alive 期限。
- wait_for_completion_timeout（可选，字符串 | -1 | 0）：等待完整结果的时间段。默认为无超时，表示请求将等待完整的搜索结果。

get_async_status编辑

返回异步 SQL 搜索或存储的同步 SQL 搜索的当前状态

端点文档

client.sql.getAsyncStatus({ id })

参数编辑

请求（对象）
- id（字符串）：搜索的标识符。

query编辑

执行 SQL 请求

端点文档

client.sql.query({ ... })

参数编辑

请求（对象）
- catalog（可选，字符串）：查询的默认目录（集群）。如果未指定，则查询仅在本地集群中的数据上执行。
- columnar（可选，布尔值）：如果为 true，则结果以列式显示：一行表示当前结果页中某个列的所有值。
- cursor（可选，字符串）：用于检索一组分页结果的游标。如果指定游标，则 API 仅使用 columnar 和 time_zone 请求正文参数。它会忽略其他请求正文参数。
- fetch_size （可选，数字）：一次响应中返回的最大行数（或条目数）。
- filter （可选，{ 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：用于额外过滤的 Elasticsearch 查询 DSL。
- query （可选，字符串）：要运行的 SQL 查询。
- request_timeout （可选，字符串 | -1 | 0）：请求失败前的超时时间。
- page_timeout （可选，字符串 | -1 | 0）：分页请求失败前的超时时间。
- time_zone （可选，字符串）：搜索的 ISO-8601 时区 ID。
- field_multi_value_leniency （可选，布尔值）：在遇到字段的多个值时抛出异常（默认），或者宽松处理并返回列表中的第一个值（不保证是哪个值，通常是自然升序的第一个值）。
- runtime_mappings（可选，Record<string, { fetch_fields, format, input_field, target_field, target_index, script, type }>）：在搜索请求中定义一个或多个运行时字段。这些字段优先于具有相同名称的映射字段。
- wait_for_completion_timeout （可选，字符串 | -1 | 0）：等待完整结果的时间段。默认为无超时，这意味着请求会等待完整的搜索结果。如果搜索未在此时间段内完成，则搜索将变为异步。
- params （可选，Record<string, 用户定义值>）：查询中参数的值。
- keep_alive （可选，字符串 | -1 | 0）：异步或已保存同步搜索的保留期。
- keep_on_completion （可选，布尔值）：如果为 true，并且还指定了 wait_for_completion_timeout 参数，则 Elasticsearch 会存储同步搜索。如果为 false，则 Elasticsearch 仅存储在 wait_for_completion_timeout 之前未完成的异步搜索。
- index_using_frozen （可选，布尔值）：如果为 true，则搜索可以在冻结的索引上运行。默认为 false。
- format （可选，字符串）：响应的格式。

translateedit

将 SQL 转换为 Elasticsearch 查询

端点文档

client.sql.translate({ query })

参数edit

请求（对象）
- query （字符串）：要运行的 SQL 查询。
- fetch_size （可选，数字）：一次响应中返回的最大行数（或条目数）。
- filter （可选，{ 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：用于额外过滤的 Elasticsearch 查询 DSL。
- time_zone （可选，字符串）：搜索的 ISO-8601 时区 ID。

ssledit

certificatesedit

检索有关用于加密集群中通信的 X.509 证书的信息。

端点文档

client.ssl.certificates()

synonymsedit

delete_synonymedit

删除同义词集

端点文档

client.synonyms.deleteSynonym({ id })

参数edit

请求（对象）
- id （字符串）：要删除的同义词集的 ID

delete_synonym_ruleedit

删除同义词集中的同义词规则

端点文档

client.synonyms.deleteSynonymRule({ set_id, rule_id })

参数edit

请求（对象）
- set_id （字符串）：要更新的同义词集的 ID
- rule_id （字符串）：要删除的同义词规则的 ID

get_synonymedit

检索同义词集

端点文档

client.synonyms.getSynonym({ id })

参数edit

请求（对象）
- id （字符串）："要检索的同义词集的 ID
- from （可选，数字）：要检索的查询规则的起始偏移量
- size （可选，数字）：指定要检索的查询规则的最大数量

get_synonym_ruleedit

从同义词集中检索同义词规则

端点文档

client.synonyms.getSynonymRule({ set_id, rule_id })

参数edit

请求（对象）
- set_id （字符串）：要从中检索同义词规则的同义词集的 ID
- rule_id （字符串）：要检索的同义词规则的 ID

get_synonyms_setsedit

检索所有已定义同义词集的摘要

端点文档

client.synonyms.getSynonymsSets({ ... })

参数edit

请求（对象）
- from （可选，数字）：起始偏移量
- size（可选，数字）：指定要获取的最大结果数

put_synonymedit

创建或更新同义词集

端点文档

client.synonyms.putSynonym({ id, synonyms_set })

参数edit

请求（对象）
- id （字符串）：要创建或更新的同义词集的 ID
- synonyms_set （{ id, synonyms }[]）：要更新的同义词集信息

put_synonym_ruleedit

在同义词集中创建或更新同义词规则

端点文档

client.synonyms.putSynonymRule({ set_id, rule_id, synonyms })

参数edit

请求（对象）
- set_id （字符串）：要使用同义词规则更新的同义词集的 ID
- rule_id （字符串）：要更新或创建的同义词规则的 ID
- synonyms （字符串）

tasksedit

canceledit

取消任务（如果可以通过 API 取消）。

端点文档

client.tasks.cancel({ ... })

参数edit

请求（对象）
- task_id （可选，字符串 | 数字）：任务的 ID。
- actions （可选，字符串 | 字符串[]）：用于限制请求的操作列表或通配符表达式。
- nodes （可选，字符串[]）：用于限制请求的节点 ID 或名称列表。
- parent_task_id （可选，字符串）：用于限制任务的父任务 ID。
- wait_for_completion （可选，布尔值）：请求是否应阻塞，直到任务及其后代任务的取消完成。默认为 false

getedit

返回有关任务的信息。

端点文档

client.tasks.get({ task_id })

参数edit

请求（对象）
- task_id （字符串）：任务的 ID。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_completion （可选，布尔值）：如果为 true，则请求会阻塞，直到任务完成。

listedit

返回任务列表。

端点文档

client.tasks.list({ ... })

参数edit

请求（对象）
- actions （可选，字符串 | 字符串[]）：用于限制请求的操作列表或通配符表达式。
- detailed（可选，布尔值）：如果为 true，则响应包含有关分片恢复的详细信息。
- group_by （可选，枚举（"nodes" | "parents" | "none"））：用于在响应中对任务进行分组的键。
- node_id （可选，字符串[]）：用于限制返回信息的节点 ID 或名称列表。
- parent_task_id （可选，字符串）：用于限制返回信息的父任务 ID。要返回所有任务，请省略此参数或使用值 -1。
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- wait_for_completion （可选，布尔值）：如果为 true，则请求将阻塞，直到操作完成。

text_structureedit

find_field_structureedit

查找索引中文本字段的结构。

端点文档

client.textStructure.findFieldStructure()

find_message_structureedit

查找消息列表的结构。消息必须包含适合摄取到 Elasticsearch 中的数据。

端点文档

client.textStructure.findMessageStructure()

find_structureedit

查找文本文件的结构。文本文件必须包含适合摄取到 Elasticsearch 中的数据。

端点文档

client.textStructure.findStructure({ ... })

参数edit

请求（对象）
- text_files （可选，TJsonDocument[]）
- charset（可选，字符串）：文本的字符集。它必须是 Elasticsearch 使用的 JVM 支持的字符集。例如，UTF-8、UTF-16LE、windows-1252 或 EUC-JP。如果未指定此参数，则结构查找器会选择适当的字符集。
- column_names（可选，字符串）：如果将格式设置为 delimited，则可以在列表中指定列名。如果未指定此参数，则结构查找器将使用文本标题行中的列名。如果文本没有标题行，则列将命名为“column1”、“column2”、“column3”等。
- delimiter（可选，字符串）：如果将格式设置为 delimited，则可以指定用于分隔每行中值的字符。仅支持单个字符；分隔符不能有多个字符。默认情况下，API 会考虑以下可能性：逗号、制表符、分号和竖线 (|)。在此默认情况下，所有行必须具有相同数量的字段，才能检测到 delimited 格式。如果指定了分隔符，则最多 10% 的行可以具有与第一行不同的列数。
- ecs_compatibility（可选，字符串）：与 ECS 兼容的 Grok 模式的兼容性模式（disabled 或 v1，默认为 disabled）。
- explain（可选，布尔值）：如果此参数设置为 true，则响应将包含一个名为 explanation 的字段，该字段是一个字符串数组，指示结构查找器如何生成其结果。
- format（可选，字符串）：文本的高级结构。有效值为 ndjson、xml、delimited 和 semi_structured_text。默认情况下，API 会选择格式。在此默认情况下，所有行必须具有相同数量的字段，才能检测到 delimited 格式。但是，如果将格式设置为 delimited 并且未设置分隔符，则 API 最多可容忍 5% 的行具有与第一行不同的列数。
- grok_pattern（可选，字符串）：如果将格式设置为 semi_structured_text，则可以指定一个 Grok 模式，用于从文本中的每条消息中提取字段。Grok 模式中时间戳字段的名称必须与 timestamp_field 参数中指定的名称匹配。如果未指定该参数，则 Grok 模式中时间戳字段的名称必须与“timestamp”匹配。如果未指定 grok_pattern，则结构查找器会创建一个 Grok 模式。
- has_header_row（可选，布尔值）：如果将格式设置为 delimited，则可以使用此参数指示列名是否位于文本的第一行中。如果未指定此参数，则结构查找器会根据文本第一行与其他行的相似性进行猜测。
- line_merge_size_limit（可选，数字）：分析半结构化文本时，合并行以形成消息时，消息中的最大字符数。如果您的消息非常长，则可能需要增加此值，但请注意，如果将行分组到消息中的方式检测错误，则可能会导致处理时间非常长。
- lines_to_sample（可选，数字）：要包含在结构分析中的行数，从文本开头算起。最小值为 2；如果此参数的值大于文本中的行数，则会对所有行进行分析（只要文本中至少有两行）。
- quote（可选，字符串）：如果将格式设置为 delimited，则可以指定用于在每行中包含换行符或分隔符时为值加引号的字符。仅支持单个字符。如果未指定此参数，则默认值为双引号 (")。如果您的带分隔符的文本格式不使用引号，则一种解决方法是将此参数设置为示例中未出现的字符。
- should_trim_fields（可选，布尔值）：如果将格式设置为 delimited，则可以指定是否应从分隔符之间的值中去除空格。如果未指定此参数且分隔符为竖线 (|)，则默认值为 true。否则，默认值为 false。
- timeout（可选，字符串 | -1 | 0）：设置结构分析所需的最长时间。如果在超时到期时分析仍在运行，则将中止分析。
- timestamp_field（可选，字符串）：用于指定文件中时间戳字段的可选参数
- timestamp_format（可选，字符串）：文本中时间戳字段的 Java 时间格式。

test_grok_pattern编辑

在某些文本上测试 Grok 模式。

端点文档

client.textStructure.testGrokPattern({ grok_pattern, text })

参数编辑

请求（对象）
- grok_pattern（字符串）：要在文本上运行的 Grok 模式。
- text（字符串数组）：要在其上运行 Grok 模式的文本行。
- ecs_compatibility（可选，字符串）：与 ECS 兼容的 Grok 模式的兼容性模式（disabled 或 v1，默认为 disabled）。

transform编辑

delete_transform编辑

删除现有的转换。

端点文档

client.transform.deleteTransform({ transform_id })

参数编辑

请求（对象）
- transform_id（字符串）：转换的标识符。
- force（可选，布尔值）：如果此值为 false，则必须先停止转换才能将其删除。如果为 true，则无论转换的当前状态如何，都将删除它。
- delete_dest_index（可选，布尔值）：如果此值为 true，则目标索引将与转换一起删除。如果为 false，则不会删除目标索引
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

get_transform编辑

检索转换的配置信息。

端点文档

client.transform.getTransform({ ... })

参数编辑

请求（对象）
- transform_id（可选，字符串 | 字符串数组）：转换的标识符。它可以是转换标识符或通配符表达式。您可以通过使用 _all、将 * 指定为 <transform_id> 或省略 <transform_id> 来获取所有转换的信息。
- allow_no_match（可选，布尔值）：指定当请求
  1. 包含通配符表达式，并且没有匹配的转换。
  2. 包含 _all 字符串或没有标识符，并且没有匹配项。
  3. 包含通配符表达式并且只有部分匹配时该怎么办。

如果此参数为 false，则当没有匹配项或只有部分匹配项时，请求将返回 404 状态代码。 from（可选，数字）：跳过指定数量的转换。 size（可选，数字）：指定要获取的最大转换数。 * *exclude_generated（可选，布尔值）：排除在创建转换时自动添加的字段。这允许以可接受的格式检索配置，然后将其添加到另一个集群。

get_transform_stats编辑

检索转换的使用情况信息。

端点文档

client.transform.getTransformStats({ transform_id })

参数编辑

请求（对象）
- transform_id（字符串 | 字符串数组）：转换的标识符。它可以是转换标识符或通配符表达式。您可以通过使用 _all、将 * 指定为 <transform_id> 或省略 <transform_id> 来获取所有转换的信息。
- allow_no_match（可选，布尔值）：指定当请求
  1. 包含通配符表达式，并且没有匹配的转换。
  2. 包含 _all 字符串或没有标识符，并且没有匹配项。
  3. 包含通配符表达式并且只有部分匹配时该怎么办。

如果此参数为 false，则当没有匹配项或只有部分匹配项时，请求将返回 404 状态代码。 from（可选，数字）：跳过指定数量的转换。 size（可选，数字）：指定要获取的最大转换数。 * *timeout（可选，字符串 | -1 | 0）：控制等待统计信息的时长

preview_transform编辑

预览转换。

端点文档

client.transform.previewTransform({ ... })

参数编辑

请求（对象）
- transform_id（可选，字符串）：要预览的转换的标识符。如果指定此路径参数，则无法在请求正文中提供转换配置详细信息。
- dest（可选，{ index、op_type、pipeline、routing、version_type }）：转换的目标位置。
- description（可选，字符串）：转换的自由文本描述。
- frequency（可选，string | -1 | 0）: 当转换持续运行时，检查源索引更改的间隔时间。还决定了在转换搜索或索引时发生瞬态故障时的重试间隔。最小值为 1 秒，最大值为 1 小时。
- pivot（可选，{ aggregations, group_by }）: 数据透视方法通过聚合和分组来转换数据。这些对象定义了分组依据字段和用于减少数据的聚合。
- source（可选，{ index, query, remote, size, slice, sort, _source, runtime_mappings }）: 转换数据的数据源。
- settings（可选，{ align_checkpoints, dates_as_epoch_millis, deduce_mappings, docs_per_second, max_page_search_size, unattended }）: 定义可选的转换设置。
- sync（可选，{ time }）: 定义转换持续运行所需的属性。
- retention_policy（可选，{ time }）: 定义转换的保留策略。满足定义条件的数据将从目标索引中删除。
- latest（可选，{ sort, unique_key }）: 最新方法通过查找每个唯一键的最新文档来转换数据。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

put_transform编辑

实例化一个转换。

端点文档

client.transform.putTransform({ transform_id, dest, source })

参数编辑

请求（对象）
- transform_id (string): 转换的标识符。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它有 64 个字符的限制，并且必须以字母数字字符开头和结尾。
- dest ({ index, op_type, pipeline, routing, version_type }): 转换的目标位置。
- source ({ index, query, remote, size, slice, sort, _source, runtime_mappings }): 转换数据的数据源。
- description（可选，字符串）：转换的自由文本描述。
- frequency（可选，string | -1 | 0）: 当转换持续运行时，检查源索引更改的间隔时间。还决定了在转换搜索或索引时发生瞬态故障时的重试间隔。最小值为 1s，最大值为 1h。
- latest（可选，{ sort, unique_key }）: 最新方法通过查找每个唯一键的最新文档来转换数据。
- _meta（可选，Record<string, 用户定义的值>）: 定义可选的转换元数据。
- pivot（可选，{ aggregations, group_by }）: 数据透视方法通过聚合和分组来转换数据。这些对象定义了分组依据字段和用于减少数据的聚合。
- retention_policy（可选，{ time }）: 定义转换的保留策略。满足定义条件的数据将从目标索引中删除。
- settings（可选，{ align_checkpoints, dates_as_epoch_millis, deduce_mappings, docs_per_second, max_page_search_size, unattended }）: 定义可选的转换设置。
- sync（可选，{ time }）: 定义转换持续运行所需的属性。
- defer_validation（可选，boolean）: 创建转换时，会进行一系列验证以确保其成功。例如，会检查源索引是否存在，以及目标索引是否属于源索引模式的一部分。您可以使用此参数跳过检查，例如当源索引在创建转换后才存在时。但是，验证始终在您启动转换时运行，权限检查除外。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

reset_transform编辑

重置现有的转换。

端点文档

client.transform.resetTransform({ transform_id })

参数编辑

请求（对象）
- transform_id (string): 转换的标识符。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它有 64 个字符的限制，并且必须以字母数字字符开头和结尾。
- force（可选，boolean）: 如果此值为 true，则无论转换的当前状态如何，都会重置转换。如果为 false，则必须先停止转换才能重置。

schedule_now_transform编辑

立即调度转换。

端点文档

client.transform.scheduleNowTransform({ transform_id })

参数编辑

请求（对象）
- transform_id（字符串）：转换的标识符。
- timeout（可选，string | -1 | 0）: 控制等待调度发生的时间

start_transform编辑

启动一个或多个转换。

端点文档

client.transform.startTransform({ transform_id })

参数编辑

请求（对象）
- transform_id（字符串）：转换的标识符。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。
- from（可选，string）: 将转换后的实体集限制为在此时间之后更改的实体。支持 now-30d 之类的相对时间。仅适用于连续转换。

stop_transform编辑

停止一个或多个转换。

端点文档

client.transform.stopTransform({ transform_id })

参数编辑

请求（对象）
- transform_id (string): 转换的标识符。要停止多个转换，请使用列表或通配符表达式。要停止所有转换，请使用 _all 或 * 作为标识符。
- allow_no_match（可选，boolean）: 指定当请求：包含通配符表达式并且没有匹配的转换；包含 _all 字符串或没有标识符并且没有匹配项；包含通配符表达式并且只有部分匹配项时该怎么做。

如果为 true，则当没有匹配项时，API 返回成功的确认消息。当只有部分匹配项时，API 会停止相应的转换。

如果为 false，则当没有匹配项或只有部分匹配项时，请求返回 404 状态代码。 force（可选，boolean）: 如果为 true，则 API 会强制停止转换。 timeout（可选，string | -1 | 0）: 当 wait_for_completion 为 true 时，等待响应的时间段。如果在超时到期之前未收到响应，则请求返回超时异常。但是，请求会继续处理，并最终将转换移动到 STOPPED 状态。 wait_for_checkpoint（可选，boolean）: 如果为 true，则转换在当前检查点完成之前不会完全停止。如果为 false，则转换会尽快停止。 wait_for_completion（可选，boolean）: 如果为 true，则 API 会阻塞，直到索引器状态完全停止。如果为 false，则 API 立即返回，并在后台异步停止索引器。

update_transform编辑

更新转换的某些属性。

端点文档

client.transform.updateTransform({ transform_id })

参数编辑

请求（对象）
- transform_id（字符串）：转换的标识符。
- dest（可选，{ index、op_type、pipeline、routing、version_type }）：转换的目标位置。
- description（可选，字符串）：转换的自由文本描述。
- frequency（可选，string | -1 | 0）: 当转换持续运行时，检查源索引更改的间隔时间。还决定了在转换搜索或索引时发生瞬态故障时的重试间隔。最小值为 1 秒，最大值为 1 小时。
- _meta（可选，Record<string, 用户定义的值>）: 定义可选的转换元数据。
- source（可选，{ index, query, remote, size, slice, sort, _source, runtime_mappings }）: 转换数据的数据源。
- settings（可选，{ align_checkpoints, dates_as_epoch_millis, deduce_mappings, docs_per_second, max_page_search_size, unattended }）: 定义可选的转换设置。
- sync（可选，{ time }）: 定义转换持续运行所需的属性。
- retention_policy（可选，{ time } | null）: 定义转换的保留策略。满足定义条件的数据将从目标索引中删除。
- defer_validation（可选，boolean）: 如果为 true，则不运行可延迟的验证。如果源索引在创建转换后才存在，则可能需要这种行为。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

upgrade_transforms编辑

升级所有转换。

端点文档

client.transform.upgradeTransforms({ ... })

参数编辑

请求（对象）
- dry_run（可选，boolean）: 如果为 true，则请求检查更新，但不运行它们。
- timeout （可选，字符串 | -1 | 0）：等待响应的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

watcher编辑

ack_watch编辑

确认监视器，手动限制监视器操作的执行。

端点文档

client.watcher.ackWatch({ watch_id })

参数编辑

请求（对象）
- watch_id (string): 监视器 ID
- action_id（可选，string | string[]）: 要确认的操作 ID 列表

activate_watch编辑

激活当前处于非活动状态的监视器。

端点文档

client.watcher.activateWatch({ watch_id })

参数编辑

请求（对象）
- watch_id (string): 监视器 ID

deactivate_watch编辑

停用当前处于活动状态的监视器。

端点文档

client.watcher.deactivateWatch({ watch_id })

参数编辑

请求（对象）
- watch_id (string): 监视器 ID

delete_watch编辑

从监视器中删除监视器。

端点文档

client.watcher.deleteWatch({ id })

参数编辑

请求（对象）
- id (string): 监视器 ID

execute_watch编辑

强制执行存储的监视器。

端点文档

client.watcher.executeWatch({ ... })

参数编辑

请求（对象）
- id（可选，string）: 监视器的标识符。
- action_modes（可选，Record<string, Enum("simulate" | "force_simulate" | "execute" | "force_execute" | "skip")>）: 确定如何在监视器执行期间处理监视器操作。
- alternative_input（可选，Record<string, 用户定义的值>）: 如果存在，则监视器使用此对象作为负载，而不是执行其自身的输入。
- ignore_condition（可选，boolean）: 设置为 true 时，监视器执行使用始终条件。这也可以作为 HTTP 参数指定。
- record_execution（可选，boolean）: 设置为 true 时，表示监视器执行结果的监视器记录将持久保存到当前时间的 .watcher-history 索引中。此外，还会更新监视器的状态，可能会限制后续执行。这也可以作为 HTTP 参数指定。
- simulated_actions（可选，{ actions, all, use_all }）
- trigger_data（可选，{ scheduled_time, triggered_time }）: 此结构被解析为触发器事件的数据，将在监视器执行期间使用
- watch （可选，{ actions, condition, input, metadata, status, throttle_period, throttle_period_in_millis, transform, trigger }）：如果存在，则使用此监视器，而不是请求中指定的监视器。此监视器不会持久保存到索引，并且不能设置 record_execution。
- debug （可选，布尔值）：定义监视器是否在调试模式下运行。

get_settings编辑

检索监视器系统索引的设置

端点文档

client.watcher.getSettings()

get_watch编辑

按 ID 检索监视器。

端点文档

client.watcher.getWatch({ id })

参数编辑

请求（对象）
- id (string): 监视器 ID

put_watch编辑

创建一个新的监视器，或更新现有的监视器。

端点文档

client.watcher.putWatch({ id })

参数编辑

请求（对象）
- id (string): 监视器 ID
- actions （可选，Record<string, { add_backing_index, remove_backing_index }>）
- condition （可选，{ always, array_compare, compare, never, script }）
- input （可选，{ chain, http, search, simple }）
- metadata （可选，Record<string, 用户定义的值>)
- throttle_period （可选，字符串）
- transform （可选，{ chain, script, search }）
- trigger （可选，{ schedule }）
- active （可选，布尔值）：指定监视器默认情况下是处于活动状态还是非活动状态
- if_primary_term （可选，数字）：仅当更改监视器的最后一个操作具有指定的 primary term 时才更新监视器
- if_seq_no （可选，数字）：仅当更改监视器的最后一个操作具有指定的序列号时才更新监视器
- version （可选，数字）：用于并发控制的显式版本号

query_watches编辑

检索已存储的监视器。

端点文档

client.watcher.queryWatches({ ... })

参数编辑

请求（对象）
- from （可选，数字）：从第一个结果开始获取的偏移量。需要是非负数。
- size （可选，数字）：要返回的结果数量。需要是非负数。
- 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_query, script, script_score, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }）：可选，查询要返回的监视器过滤器。
- sort （可选，字符串 | { _score, _doc, _geo_distance, _script } | 字符串 | { _score, _doc, _geo_distance, _script }[]）：可选排序定义。
- search_after （可选，数字 | 数字 | 字符串 | 布尔值 | null | 用户定义的值[]）：可选的 Search After，用于使用最后一次命中的排序值进行分页。

start编辑

如果 Watcher 尚未运行，则启动它。

端点文档

client.watcher.start()

stats编辑

检索当前的 Watcher 指标。

端点文档

client.watcher.stats({ ... })

参数编辑

请求（对象）
- metric （可选，枚举（“_all” | “queued_watches” | “current_watches” | “pending_watches”） | 枚举（“_all” | “queued_watches” | “current_watches” | “pending_watches”）[]）：定义响应中包含哪些其他指标。
- emit_stacktraces （可选，布尔值）：定义是否为每个正在运行的监视器生成堆栈跟踪。

stop编辑

如果 Watcher 正在运行，则停止它。

端点文档

client.watcher.stop()

update_settings编辑

更新监视器系统索引的设置

端点文档

client.watcher.updateSettings()

xpack编辑

info编辑

检索有关已安装 X-Pack 功能的信息。

端点文档

client.xpack.info({ ... })

参数编辑

请求（对象）
- categories （可选，字符串[]）：要包含在响应中的信息类别的列表。例如，build,license,features。
- accept_enterprise （可选，布尔值）：如果使用此参数，则必须将其设置为 true
- human （可选，布尔值）：定义响应中是否包含其他人类可读的信息。特别是，它添加了描述和标语。

usage编辑

检索有关已安装 X-Pack 功能的使用情况信息。

端点文档

client.xpack.usage({ ... })

参数编辑

请求（对象）
- master_timeout （可选，字符串 | -1 | 0）：等待连接到主节点的期限。如果在超时到期之前没有收到响应，则请求失败并返回错误。

« TypeScript 支持示例 »