Elasticsearch根API详解：获取集群基本信息-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00212/article/details/148325174

Elasticsearch根API详解：获取集群基本信息

elasticsearch 项目地址: https://gitcode.com/gh_mirrors/elas/elasticsearch

什么是根API

Elasticsearch的根API（Root API）是Elasticsearch REST API体系中最基础的接口，通过向Elasticsearch服务的根路径发送GET请求，可以获取当前节点的基本信息、集群状态以及版本信息等关键数据。这个API通常用于快速验证Elasticsearch服务是否正常运行，以及获取环境的基本配置信息。

如何使用根API

使用根API非常简单，只需要向Elasticsearch服务的根路径发送一个GET请求即可：

GET /

这个请求不需要任何参数，返回的结果包含了丰富的信息，下面我们会详细解析这些返回字段的含义。

返回字段详解

根API的返回结果是一个JSON对象，包含以下主要字段：

1. 节点和集群信息

name：当前响应节点的名称，这是在Elasticsearch配置中设置的节点名
cluster_name：当前节点所属的集群名称
cluster_uuid：集群的唯一标识符，由Elasticsearch自动生成

2. 版本信息

version字段是一个嵌套对象，包含了详细的版本和构建信息：

number：当前运行的Elasticsearch版本号
build_flavor：构建类型，如"default"表示标准版
build_type：安装方式，如"docker"、"rpm"、"tar"等
build_hash：构建时对应的Git提交哈希值
build_date：构建日期
build_snapshot：是否为快照版本
lucene_version：底层Lucene库的版本号
minimum_wire_compatibility_version：节点间通信的最低兼容版本
minimum_index_compatibility_version：可读取索引的最低兼容版本

安全注意事项

如果启用了Elasticsearch的安全功能，使用根API需要具备以下集群权限之一：

monitor
manage
all

没有适当权限的用户将无法访问此API。

典型应用场景

服务健康检查：通过根API可以快速确认Elasticsearch服务是否正常运行
版本验证：在升级或迁移前确认当前运行的版本信息
环境配置检查：确认集群名称、节点名称等基础配置
兼容性检查：通过minimum_wire_compatibility_version和minimum_index_compatibility_version字段评估升级或迁移的兼容性

响应示例

以下是一个典型的根API响应示例：

{
  "name": "es-node-1",
  "cluster_name": "production-cluster",
  "cluster_uuid": "5QaxoN0pRZuOmWSxstBBwQ",
  "version": {
    "number": "8.12.1",
    "build_flavor": "default",
    "build_type": "docker",
    "build_hash": "6185ba65d27469afabc9bc951cded6c17c21e3f3",
    "build_date": "2024-02-01T13:07:13.727175297Z",
    "build_snapshot": false,
    "lucene_version": "9.9.2",
    "minimum_wire_compatibility_version": "7.17.0",
    "minimum_index_compatibility_version": "7.0.0"
  },
  "tagline": "You Know, for Search"
}