cat indices API
编辑cat indices API
编辑cat API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适用于应用程序。对于应用程序使用，请使用获取索引 API。
返回有关集群中索引的高级信息，包括数据流的备份索引。
先决条件
编辑描述
编辑使用 cat indices API 获取集群中每个索引的以下信息
- 分片数量
- 文档数量
- 已删除文档数量
- 主存储大小
- 所有分片（包括分片副本）的总存储大小
这些指标直接从Lucene（Elasticsearch 用于支持索引和搜索的内部工具）中检索。因此，所有文档计数都包含隐藏的嵌套文档。
要获取 Elasticsearch 文档的准确计数，请使用cat count或count API。
请注意，对于从仅源快照还原的索引，不会显示文档计数、已删除文档计数和存储大小等信息，因为这些索引不包含从这些信息中检索相关数据结构。
路径参数
编辑-
<target> - (可选，字符串) 用于限制请求的数据流、索引和别名的逗号分隔列表。支持通配符 (
*)。要定位所有数据流和索引，请省略此参数或使用*或_all。
查询参数
编辑-
bytes - (可选，字节大小单位) 用于显示字节值的单位。
-
format - (可选，字符串)HTTP accept 标头的简短版本。有效值包括 JSON、YAML 等。
-
h - (可选，字符串) 要显示的列名称的逗号分隔列表。
-
health -
(可选，字符串) 用于限制返回索引的健康状态。有效值为
-
green -
yellow -
red
默认情况下，响应包括任何健康状态的索引。
-
-
help - (可选，布尔值) 如果
true，则响应包含帮助信息。默认为false。 -
include_unloaded_segments - (可选，布尔值) 如果
true，则响应包含来自未加载到内存中的段的信息。默认为false。 -
master_timeout - (可选，时间单位) 等待主节点的时间段。如果主节点在超时过期前不可用，则请求失败并返回错误。默认为
30s。也可以设置为-1以指示请求永远不会超时。
-
pri（主分片） - (可选，布尔值) 如果
true，则响应仅包含来自主分片的信息。默认为false。 -
s - (可选，字符串) 用于对响应进行排序的列名称或列别名的逗号分隔列表。
-
time - (可选，时间单位) 用于显示时间值的单位。
-
v - (可选，布尔值) 如果
true，则响应包含列标题。默认为false。 -
expand_wildcards -
(可选，字符串) 通配符模式可以匹配的索引类型。如果请求可以定位数据流，则此参数确定通配符表达式是否匹配隐藏的数据流。支持逗号分隔的值，例如
open,hidden。有效值为-
all - 匹配任何数据流或索引，包括隐藏的。
-
open - 匹配打开的、非隐藏的索引。也匹配任何非隐藏的数据流。
-
closed - 匹配关闭的、非隐藏的索引。也匹配任何非隐藏的数据流。数据流无法关闭。
-
hidden - 匹配隐藏的数据流和隐藏的索引。必须与
open、closed或两者结合使用。 -
none - 不接受通配符模式。
-
示例
编辑resp = client.cat.indices(
index="my-index-*",
v=True,
s="index",
)
print(resp)
response = client.cat.indices( index: 'my-index-*', v: true, s: 'index' ) puts response
const response = await client.cat.indices({
index: "my-index-*",
v: "true",
s: "index",
});
console.log(response);
GET /_cat/indices/my-index-*?v=true&s=index
API 返回以下响应
health status index uuid pri rep docs.count docs.deleted store.size pri.store.size dataset.size yellow open my-index-000001 u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb 88.1kb green open my-index-000002 nYFWZEO7TUiOjLQXBaYJpA 1 0 0 0 260b 260b 260b