列出索引
2.18 版引入
列出索引操作以分页格式提供以下索引信息
- 索引使用的磁盘空间量。
- 索引中包含的分片数量。
- 索引的健康状态。
端点
GET _list/indices
GET _list/indices/<index>
查询参数
参数 | 类型 | 描述 |
---|---|---|
bytes(字节) | 字节大小 | 指定字节大小的单位,例如 7kb 或 6gb 。有关更多信息,请参阅支持的单位。 |
health | 字符串 | 根据索引的健康状态限制索引。支持的值为 green 、yellow 和 red 。 |
include_unloaded_segments | 布尔型 | 是否包含未加载到内存中的段信息。默认为 false 。 |
cluster_manager_timeout | 时间 | 等待连接到集群管理器节点的时间量。默认值为 30s 。 |
pri | 布尔型 | 是否仅返回主分片的信息。默认为 false 。 |
time | 时间 | 指定时间单位,例如 5d 或 7h 。有关更多信息,请参阅支持的单位。 |
expand_wildcards | 枚举 | 将通配符表达式扩展为具体索引。使用逗号组合多个值。支持的值为 all 、open 、closed 、hidden 和 none 。默认为 open 。 |
next_token | 字符串 | 获取下一页索引。当为 null 时,仅提供第一页索引。默认为 null 。 |
size | 整数 | 单页显示的最大索引数。响应的单页索引数并不总是等于指定的 size 。默认为 500 。最小值为 1 ,最大值为 5000 。 |
sort(排序) | 字符串 | 索引的显示顺序。如果为 desc ,则最新创建的索引最先显示。如果为 asc ,则最旧的索引最先显示。默认为 asc 。 |
当使用 next_token
路径参数时,使用响应生成的令牌来查看下一页索引。当 API 返回 null
后,API 中包含的所有索引都已返回。
示例请求
要获取所有索引的信息,请使用以下查询并持续指定从响应中接收到的 next_token
,直到它为 null
GET _list/indices/<index>?v&next_token=token
要将信息限制到特定索引,请在查询后添加索引名称,示例如下
GET _list/indices/<index>?v
要获取多个索引的信息,请用逗号分隔索引,示例如下
GET _list/indices/index1,index2,index3?v&next_token=token
示例响应
纯文本格式
health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size
green | open | movies | UZbpfERBQ1-3GSH2bnM3sg | 1 | 1 | 1 | 0 | 7.7kb | 3.8kb
next_token MTcyOTE5NTQ5NjM5N3wub3BlbnNlYXJjaC1zYXAtbG9nLXR5cGVzLWNvbmZpZw==
JSON 格式
{
"next_token": "MTcyOTE5NTQ5NjM5N3wub3BlbnNlYXJjaC1zYXAtbG9nLXR5cGVzLWNvbmZpZw==",
"indices": [
{
"health": "green",
"status": "open",
"index": "movies",
"uuid": "UZbpfERBQ1-3GSH2bnM3sg",
"pri": "1",
"rep": "1",
"docs.count": "1",
"docs.deleted": "0",
"store.size": "7.7kb",
"pri.store.size": "3.8kb"
}
]
}