« cat repositories API cat shards API »
Elastic 文档 ›Elasticsearch 指南 [8.17] ›REST APIs ›紧凑对齐文本 (CAT) API

cat segments API

编辑

cat segments API

编辑

cat API 仅供人类通过命令行或 Kibana 控制台使用。不 适用于应用程序使用。对于应用程序使用，请使用 索引段 API。

返回关于索引分片中 Lucene 段的底层信息，类似于 indices segments API。

对于数据流，API 返回关于数据流的支持索引的信息。

请求

编辑

GET /_cat/segments/<target>

GET /_cat/segments

前提条件

编辑
  • 如果启用了 Elasticsearch 安全功能，您必须拥有 monitor 或 manage 集群权限 才能使用此 API。您还必须拥有您检索的任何数据流、索引或别名的 monitor 或 manage 索引权限。

路径参数

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

查询参数

编辑
bytes
(可选, 字节大小单位) 用于显示字节值的单位。
format
(可选, 字符串) HTTP accept 标头的简短版本。有效值包括 JSON、YAML 等。
h

(可选, 字符串) 要显示的列名称的逗号分隔列表。

如果您不指定要包含的列，API 将按以下列出的顺序返回默认列。如果您显式指定一个或多个列，则它仅返回指定的列。

有效列为

index, i, idx
(默认) 索引的名称。
shard, s, sh
(默认) 分片的名称。
prirep, p, pr, primaryOrReplica
(默认) 分片类型。返回的值为 primary 或 replica。
ip
(默认) 段的分片的 IP 地址，例如 127.0.1.1。
segment
(默认) 段的名称，例如 _0。段名称从段生成派生，并在内部用于在分片的目录中创建文件名。
generation
(默认) 生成编号，例如 0。Elasticsearch 为写入的每个段递增此生成编号。然后，Elasticsearch 使用此数字来派生段名称。
docs.count
(默认) Lucene 报告的文档数量。这不包括已删除的文档，并将任何 嵌套文档 与其父文档分开计数。它也不包括最近索引的且尚未属于某个段的文档。
docs.deleted
(默认) Lucene 报告的已删除文档的数量，该数量可能高于或低于您执行的删除操作的数量。此数字不包括最近执行的且尚未属于某个段的删除操作。如果这样做有意义，自动合并过程会清理已删除的文档。此外，Elasticsearch 会创建额外的已删除文档，以便在内部跟踪分片上的最近操作历史记录。
size
(默认) 段使用的磁盘空间，例如 50kb。
size.memory

(默认) 存储在内存中以进行高效搜索的段数据的字节数，例如 1264。

-1 的值表示 Elasticsearch 无法计算此数字。

committed

(默认) 如果为 true，则段已同步到磁盘。同步的段可以在硬重启后幸存。

如果为 false，则未提交的段的数据也会存储在事务日志中，以便 Elasticsearch 能够在下次启动时重播更改。

searchable

(默认) 如果为 true，则该段可搜索。

如果为 false，则该段很可能已写入磁盘，但需要 刷新才能搜索。

version
(默认) 用于写入段的 Lucene 版本。
compound
(默认) 如果为 true，则段存储在复合文件中。这意味着 Lucene 将段中的所有文件合并到一个文件中，以节省文件描述符。
id
节点的 ID，例如 k0zy。
help
(可选, 布尔值) 如果为 true，则响应包含帮助信息。默认为 false。
s
(可选, 字符串) 用于对响应进行排序的列名称或列别名的逗号分隔列表。
v
(可选, 布尔值) 如果为 true，则响应包含列标题。默认为 false。

示例

编辑
resp = client.cat.segments(
    v=True,
)
print(resp)
response = client.cat.segments(
  v: true
)
puts response
const response = await client.cat.segments({
  v: "true",
});
console.log(response);
GET /_cat/segments?v=true

API 返回以下响应

index shard prirep ip        segment generation docs.count docs.deleted size size.memory committed searchable version compound
test  0     p      127.0.0.1 _0               0          1            0  3kb           0 false     true       9.12.0   true
test1 0     p      127.0.0.1 _0               0          1            0  3kb           0 false     true       9.12.0   true
« cat repositories API cat shards API »