获取 Easysearch 节点的基本信息,包括节点名称、集群名称、集群 UUID、版本信息等。
API #
GET /
HEAD /
API 的作用 #
该 API 用于快速了解 Easysearch 节点的基本信息和版本状态,是集群管理中最基础的接口之一。
返回的信息包括:
- 节点名称 (name)
- 集群名称 (cluster_name)
- 集群 UUID (cluster_uuid)
- 版本信息 (version),包括版本号、构建哈希、构建日期、Lucene 版本等
- 分发信息 (distribution)
- 分销商信息 (distributor)
- 标语 (tagline)
API 的参数 #
Query String 参数 #
| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
pretty | 布尔值 | 否 | true | 格式化 JSON 输出,使其更易读 |
format | 字符串 | 否 | json | 指定响应的格式(如 json、yaml) |
human | 布尔值 | 否 | false | 控制是否以人类可读的格式返回统计信息 |
filter_path | 字符串 | 否 | 所有字段 | 用于减少响应中的字段,支持点号分隔的路径和通配符 |
error_trace | 布尔值 | 否 | false | 是否在错误响应中包含堆栈跟踪信息 |
示例 #
基本请求 #
GET /
响应示例:
{
"name": "node-1",
"cluster_name": "easysearch-cluster",
"cluster_uuid": "some-uuid",
"version": {
"distribution": "easysearch",
"number": "1.0.0",
"distributor": "INFINI Labs",
"build_hash": "abc123",
"build_date": "2026-01-01T00:00:00Z",
"build_snapshot": false,
"lucene_version": "8.10.0",
"minimum_wire_lucene_version": "6.8.0",
"minimum_lucene_index_compatibility_version": "6.8.0"
},
"tagline": "You Know, For Easy Search!"
}
带格式化参数的请求 #
GET /?pretty=true
过滤响应字段 #
GET /?filter_path=name,cluster_name,version.number
响应示例:
{
"name": "node-1",
"cluster_name": "easysearch-cluster",
"version": {
"number": "1.0.0"
}
}





