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

cat segments API

编辑

cat segments API

编辑

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

返回有关索引分片中Lucene 分段的低级信息，类似于索引分段 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 »