列出分片
2.18 版引入
列表分片操作以分页格式输出所有主分片和副本分片的状态及其分布情况。
端点
GET _list/shards
GET _list/shards/<index>
查询参数
所有参数都是可选的。
参数 | 类型 | 描述 |
---|---|---|
bytes(字节) | 字节大小 | 指定字节大小单位,例如 7kb 或 6gb 。有关更多信息,请参阅支持的单位。 |
local | 布尔型 | 是否仅从本地节点而不是集群管理节点返回信息。默认为 false 。 |
cluster_manager_timeout | 时间 | 等待连接到集群管理器节点的时间量。默认值为 30s 。 |
cancel_after_time_interval | 时间 | 分片请求在此时间后被取消。默认为 -1 (无超时)。 |
time | 时间 | 指定时间单位,例如 5d 或 7h 。有关更多信息,请参阅支持的单位。 |
next_token | 字符串 | 获取下一页索引。当为 null 时,仅提供第一页索引。默认为 null 。 |
size | 整数 | 单页上显示的索引的最大数量。响应单页上的索引数量不总是等于指定的 size 。默认和最小值为 2000 。最大值为 20000 。 |
sort(排序) | 字符串 | 索引的显示顺序。如果为 desc ,则最新创建的索引最先显示。如果为 asc ,则最旧的索引最先显示。默认为 asc 。 |
使用 next_token
路径参数时,使用响应生成的令牌查看下一页索引。当 API 返回 null
后,表示 API 中包含的所有索引都已返回。
示例请求
要获取所有索引和分片的信息,请使用以下查询,并持续指定从响应中收到的 next_token
,直到其为 null
GET _list/shards/<index>?v&next_token=token
要将信息限制到特定索引,请在查询后添加索引名称,如以下示例所示,并持续指定从响应中收到的 next_token
,直到其为 null
GET _list/shards/<index>?v&next_token=token
如果要获取多个索引的信息,请用逗号分隔索引,如以下示例所示:
GET _list/shards/index1,index2,index3?v&next_token=token
示例响应
纯文本格式
index | shard | prirep | state | docs | store | ip | | node
plugins | 0 | p | STARTED | 0 | 208b | 172.18.0.4 | odfe-node1
plugins | 0 | r | STARTED | 0 | 208b | 172.18.0.3 | odfe-node2
....
....
next_token MTcyOTE5NTQ5NjM5N3wub3BlbnNlYXJjaC1zYXAtbG9nLXR5cGVzLWNvbmZpZw==
JSON 格式
{
"next_token": "MTcyOTE5NTQ5NjM5N3wub3BlbnNlYXJjaC1zYXAtbG9nLXR5cGVzLWNvbmZpZw==",
"shards": [
{
"index": "plugins",
"shard": "0",
"prirep": "p",
"state": "STARTED",
"docs": "0",
"store": "208B",
"ip": "172.18.0.4",
"node": "odfe-node1"
},
{
"index": "plugins",
"shard": "0",
"prirep": "r",
"state": "STARTED",
"docs": "0",
"store": "208B",
"ip": "172.18.0.3",
"node": "odfe-node2"
}
]
}