- Elasticsearch 指南其他版本
- 8.17 中的新功能
- Elasticsearch 基础
- 快速入门
- 设置 Elasticsearch
- 升级 Elasticsearch
- 索引模块
- 映射
- 文本分析
- 索引模板
- 数据流
- 摄取管道
- 别名
- 搜索您的数据
- 重新排名
- 查询 DSL
- 聚合
- 地理空间分析
- 连接器
- EQL
- ES|QL
- SQL
- 脚本
- 数据管理
- 自动缩放
- 监视集群
- 汇总或转换数据
- 设置高可用性集群
- 快照和还原
- 保护 Elastic Stack 的安全
- Watcher
- 命令行工具
- elasticsearch-certgen
- elasticsearch-certutil
- elasticsearch-create-enrollment-token
- elasticsearch-croneval
- elasticsearch-keystore
- elasticsearch-node
- elasticsearch-reconfigure-node
- elasticsearch-reset-password
- elasticsearch-saml-metadata
- elasticsearch-service-tokens
- elasticsearch-setup-passwords
- elasticsearch-shard
- elasticsearch-syskeygen
- elasticsearch-users
- 优化
- 故障排除
- 修复常见的集群问题
- 诊断未分配的分片
- 向系统中添加丢失的层
- 允许 Elasticsearch 在系统中分配数据
- 允许 Elasticsearch 分配索引
- 索引将索引分配过滤器与数据层节点角色混合,以在数据层之间移动
- 没有足够的节点来分配所有分片副本
- 单个节点上索引的分片总数已超过
- 每个节点的分片总数已达到
- 故障排除损坏
- 修复磁盘空间不足的数据节点
- 修复磁盘空间不足的主节点
- 修复磁盘空间不足的其他角色节点
- 启动索引生命周期管理
- 启动快照生命周期管理
- 从快照恢复
- 故障排除损坏的存储库
- 解决重复的快照策略失败问题
- 故障排除不稳定的集群
- 故障排除发现
- 故障排除监控
- 故障排除转换
- 故障排除 Watcher
- 故障排除搜索
- 故障排除分片容量健康问题
- 故障排除不平衡的集群
- 捕获诊断信息
- REST API
- API 约定
- 通用选项
- REST API 兼容性
- 自动缩放 API
- 行为分析 API
- 紧凑和对齐文本 (CAT) API
- 集群 API
- 跨集群复制 API
- 连接器 API
- 数据流 API
- 文档 API
- 丰富 API
- EQL API
- ES|QL API
- 功能 API
- Fleet API
- 图表探索 API
- 索引 API
- 别名是否存在
- 别名
- 分析
- 分析索引磁盘使用量
- 清除缓存
- 克隆索引
- 关闭索引
- 创建索引
- 创建或更新别名
- 创建或更新组件模板
- 创建或更新索引模板
- 创建或更新索引模板(旧版)
- 删除组件模板
- 删除悬挂索引
- 删除别名
- 删除索引
- 删除索引模板
- 删除索引模板(旧版)
- 存在
- 字段使用情况统计信息
- 刷新
- 强制合并
- 获取别名
- 获取组件模板
- 获取字段映射
- 获取索引
- 获取索引设置
- 获取索引模板
- 获取索引模板(旧版)
- 获取映射
- 导入悬挂索引
- 索引恢复
- 索引段
- 索引分片存储
- 索引统计信息
- 索引模板是否存在(旧版)
- 列出悬挂索引
- 打开索引
- 刷新
- 解析索引
- 解析集群
- 翻转
- 收缩索引
- 模拟索引
- 模拟模板
- 拆分索引
- 解冻索引
- 更新索引设置
- 更新映射
- 索引生命周期管理 API
- 推理 API
- 信息 API
- 摄取 API
- 许可 API
- Logstash API
- 机器学习 API
- 机器学习异常检测 API
- 机器学习数据帧分析 API
- 机器学习训练模型 API
- 迁移 API
- 节点生命周期 API
- 查询规则 API
- 重新加载搜索分析器 API
- 存储库计量 API
- 汇总 API
- 根 API
- 脚本 API
- 搜索 API
- 搜索应用程序 API
- 可搜索快照 API
- 安全 API
- 身份验证
- 更改密码
- 清除缓存
- 清除角色缓存
- 清除权限缓存
- 清除 API 密钥缓存
- 清除服务帐户令牌缓存
- 创建 API 密钥
- 创建或更新应用程序权限
- 创建或更新角色映射
- 创建或更新角色
- 批量创建或更新角色 API
- 批量删除角色 API
- 创建或更新用户
- 创建服务帐户令牌
- 委托 PKI 身份验证
- 删除应用程序权限
- 删除角色映射
- 删除角色
- 删除服务帐户令牌
- 删除用户
- 禁用用户
- 启用用户
- 注册 Kibana
- 注册节点
- 获取 API 密钥信息
- 获取应用程序权限
- 获取内置权限
- 获取角色映射
- 获取角色
- 查询角色
- 获取服务帐户
- 获取服务帐户凭据
- 获取安全设置
- 获取令牌
- 获取用户权限
- 获取用户
- 授予 API 密钥
- 具有权限
- 使 API 密钥失效
- 使令牌失效
- OpenID Connect 准备身份验证
- OpenID Connect 身份验证
- OpenID Connect 注销
- 查询 API 密钥信息
- 查询用户
- 更新 API 密钥
- 更新安全设置
- 批量更新 API 密钥
- SAML 准备身份验证
- SAML 身份验证
- SAML 注销
- SAML 失效
- SAML 完成注销
- SAML 服务提供商元数据
- SSL 证书
- 激活用户配置文件
- 禁用用户配置文件
- 启用用户配置文件
- 获取用户配置文件
- 建议用户配置文件
- 更新用户配置文件数据
- 具有用户配置文件权限
- 创建跨集群 API 密钥
- 更新跨集群 API 密钥
- 快照和还原 API
- 快照生命周期管理 API
- SQL API
- 同义词 API
- 文本结构 API
- 转换 API
- 使用情况 API
- Watcher API
- 定义
- 迁移指南
- 发行说明
- Elasticsearch 版本 8.17.0
- Elasticsearch 版本 8.16.1
- Elasticsearch 版本 8.16.0
- Elasticsearch 版本 8.15.5
- Elasticsearch 版本 8.15.4
- Elasticsearch 版本 8.15.3
- Elasticsearch 版本 8.15.2
- Elasticsearch 版本 8.15.1
- Elasticsearch 版本 8.15.0
- Elasticsearch 版本 8.14.3
- Elasticsearch 版本 8.14.2
- Elasticsearch 版本 8.14.1
- Elasticsearch 版本 8.14.0
- Elasticsearch 版本 8.13.4
- Elasticsearch 版本 8.13.3
- Elasticsearch 版本 8.13.2
- Elasticsearch 版本 8.13.1
- Elasticsearch 版本 8.13.0
- Elasticsearch 版本 8.12.2
- Elasticsearch 版本 8.12.1
- Elasticsearch 版本 8.12.0
- Elasticsearch 版本 8.11.4
- Elasticsearch 版本 8.11.3
- Elasticsearch 版本 8.11.2
- Elasticsearch 版本 8.11.1
- Elasticsearch 版本 8.11.0
- Elasticsearch 版本 8.10.4
- Elasticsearch 版本 8.10.3
- Elasticsearch 版本 8.10.2
- Elasticsearch 版本 8.10.1
- Elasticsearch 版本 8.10.0
- Elasticsearch 版本 8.9.2
- Elasticsearch 版本 8.9.1
- Elasticsearch 版本 8.9.0
- Elasticsearch 版本 8.8.2
- Elasticsearch 版本 8.8.1
- Elasticsearch 版本 8.8.0
- Elasticsearch 版本 8.7.1
- Elasticsearch 版本 8.7.0
- Elasticsearch 版本 8.6.2
- Elasticsearch 版本 8.6.1
- Elasticsearch 版本 8.6.0
- Elasticsearch 版本 8.5.3
- Elasticsearch 版本 8.5.2
- Elasticsearch 版本 8.5.1
- Elasticsearch 版本 8.5.0
- Elasticsearch 版本 8.4.3
- Elasticsearch 版本 8.4.2
- Elasticsearch 版本 8.4.1
- Elasticsearch 版本 8.4.0
- Elasticsearch 版本 8.3.3
- Elasticsearch 版本 8.3.2
- Elasticsearch 版本 8.3.1
- Elasticsearch 版本 8.3.0
- Elasticsearch 版本 8.2.3
- Elasticsearch 版本 8.2.2
- Elasticsearch 版本 8.2.1
- Elasticsearch 版本 8.2.0
- Elasticsearch 版本 8.1.3
- Elasticsearch 版本 8.1.2
- Elasticsearch 版本 8.1.1
- Elasticsearch 版本 8.1.0
- Elasticsearch 版本 8.0.1
- Elasticsearch 版本 8.0.0
- Elasticsearch 版本 8.0.0-rc2
- Elasticsearch 版本 8.0.0-rc1
- Elasticsearch 版本 8.0.0-beta1
- Elasticsearch 版本 8.0.0-alpha2
- Elasticsearch 版本 8.0.0-alpha1
- 依赖项和版本
集群状态 API
编辑集群状态 API
编辑返回集群状态的内部表示,用于调试或诊断目的。
请求
编辑GET /_cluster/state/<metrics>/<target>
描述
编辑集群状态是一个内部数据结构,它跟踪每个节点所需的各种信息,包括:
- 集群中其他节点的身份和属性
- 集群范围内的设置
- 索引元数据,包括每个索引的映射和设置
- 集群中每个分片副本的位置和状态
选定的主节点确保集群中的每个节点都有相同集群状态的副本。集群状态 API 允许您检索此内部状态的表示形式,以进行调试或诊断。您可能需要参考 Elasticsearch 源代码来确定响应的确切含义。
默认情况下,集群状态 API 会将请求路由到选定的主节点,因为该节点是集群状态的权威来源。您还可以通过添加查询参数 ?local=true
来检索处理 API 请求的节点上保留的集群状态。
Elasticsearch 可能需要花费大量精力来计算大型集群对此 API 的响应,并且响应可能包含大量数据。如果您重复使用此 API,您的集群可能会变得不稳定。
响应是内部数据结构的表示。它的格式不受与其他更稳定的 API 相同的兼容性保证的约束,并且可能会因版本而异。 请勿使用外部监视工具查询此 API。 请改为使用其他更稳定的 集群 API 获取您需要的信息。
路径参数
编辑集群状态有时可能非常大,并且 Elasticsearch 在计算此 API 的响应时可能会消耗大量资源。要减小响应的大小,您可以仅请求您感兴趣的集群状态部分
-
<metrics>
-
(可选,字符串)以下选项的逗号分隔列表
-
_all
- 显示所有指标。
-
blocks
- 显示响应的
blocks
部分。 -
master_node
- 显示响应的
master_node
部分。 -
metadata
- 显示响应的
metadata
部分。如果您提供索引的逗号分隔列表,则返回的输出将仅包含这些索引的元数据。 -
nodes
- 显示响应的
nodes
部分。 -
routing_nodes
- 显示响应的
routing_nodes
部分。 -
routing_table
- 显示响应的
routing_table
部分。如果您提供索引的逗号分隔列表,则返回的输出将仅包含这些索引的路由表。 -
version
- 显示集群状态版本。
-
-
<target>
- (可选,字符串)用于限制请求的数据流、索引和别名的逗号分隔列表。支持通配符 (
*
)。要定位所有数据流和索引,请省略此参数或使用*
或_all
。
查询参数
编辑-
allow_no_indices
-
(可选,布尔值)如果为
true
,则将忽略解析为没有具体索引的通配符索引表达式。(包括_all
字符串或未指定索引时)。默认为
true
。 -
expand_wildcards
- (可选,字符串)是否将通配符表达式展开为打开、关闭或两者兼有的具体索引。可用选项:
open
、closed
、none
、all
。 -
flat_settings
- (可选,布尔值)如果为
true
,则以扁平格式返回设置。默认为false
。 -
ignore_unavailable
- (可选,布尔值)如果为
true
,则会忽略不可用的索引(丢失或关闭)。 -
local
- (可选,布尔值)如果为
true
,则请求仅从本地节点检索信息。默认为false
,这意味着从主节点检索信息。 -
master_timeout
- (可选,时间单位)等待主节点的时间。如果在超时到期之前主节点不可用,则请求失败并返回错误。默认为
30s
。也可以设置为-1
,表示请求永远不应超时。 -
wait_for_metadata_version
- (可选,整数)等待元数据版本等于或大于指定的元数据版本。
-
wait_for_timeout
- (可选,时间单位)指定在超时之前等待 wait_for_metadata_version 的最长时间。
示例
编辑以下示例仅返回 foo
和 bar
数据流或索引的 metadata
和 routing_table
数据
resp = client.cluster.state( metric="metadata,routing_table", index="foo,bar", ) print(resp)
response = client.cluster.state( metric: 'metadata,routing_table', index: 'foo,bar' ) puts response
const response = await client.cluster.state({ metric: "metadata,routing_table", index: "foo,bar", }); console.log(response);
GET /_cluster/state/metadata,routing_table/foo,bar
下一个示例返回 foo
和 bar
的所有可用元数据
resp = client.cluster.state( metric="_all", index="foo,bar", ) print(resp)
response = client.cluster.state( metric: '_all', index: 'foo,bar' ) puts response
const response = await client.cluster.state({ metric: "_all", index: "foo,bar", }); console.log(response);
GET /_cluster/state/_all/foo,bar
此示例仅返回 blocks
元数据
resp = client.cluster.state( metric="blocks", ) print(resp)
response = client.cluster.state( metric: 'blocks' ) puts response
const response = await client.cluster.state({ metric: "blocks", }); console.log(response);
GET /_cluster/state/blocks