cat count API编辑

cat API 仅供使用命令行或 Kibana 控制台的人类使用。它们适用于应用程序。对于应用程序使用,请使用 count API

提供对数据流、索引或整个集群的文档计数的快速访问。

文档计数仅包含活动文档,不包括尚未被合并过程删除的已删除文档。

请求编辑

GET /_cat/count/<target>

GET /_cat/count

先决条件编辑

  • 如果启用了 Elasticsearch 安全功能,则您必须对要检索的任何数据流、索引或别名具有 read 索引权限

路径参数编辑

<target>
(可选,字符串) 用于限制请求的数据流、索引和别名的逗号分隔列表。支持通配符 (*)。要定位所有数据流和索引,请省略此参数或使用 *_all

查询参数编辑

format
(可选,字符串) HTTP accept 标头 的简短版本。有效值包括 JSON、YAML 等。
h
(可选,字符串) 要显示的列名称的逗号分隔列表。
help
(可选,布尔值) 如果为 true,则响应将包含帮助信息。默认为 false
s
(可选,字符串) 用于对响应进行排序的列名称或列别名的逗号分隔列表。
v
(可选,布尔值) 如果为 true,则响应将包含列标题。默认为 false

示例编辑

使用单个数据流或索引的示例编辑

以下 count API 请求检索 my-index-000001 数据流或索引的文档计数。

response = client.cat.count(
  index: 'my-index-000001',
  v: true
)
puts response
GET /_cat/count/my-index-000001?v=true

API 返回以下响应

epoch      timestamp count
1475868259 15:24:20  120

使用集群中的所有数据流和索引的示例编辑

以下 count API 请求检索集群中所有数据流和索引的文档计数。

response = client.cat.count(
  v: true
)
puts response
GET /_cat/count?v=true

API 返回以下响应

epoch      timestamp count
1475868259 15:24:20  121