cat segments API
编辑cat segments API编辑
cat API 仅用于使用命令行或 Kibana 控制台的人类使用。它们不适用于应用程序。对于应用程序使用，请使用 索引段 API.
返回有关索引分片中 Lucene 段的低级信息，类似于 索引段 API.
对于数据流，API 返回有关流的备份索引的信息。
先决条件编辑
路径参数编辑
-
<target> - (可选，字符串) 用于限制请求的数据流、索引和别名的逗号分隔列表。支持通配符 (
*)。要定位所有数据流和索引，请省略此参数或使用*或_all。
查询参数编辑
-
bytes - (可选，字节大小单位) 用于显示字节值的单位。
-
format - (可选，字符串) HTTP 接受标头 的简短版本。有效值包括 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。
示例编辑
response = client.cat.segments( v: true ) puts 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.10.0 true test1 0 p 127.0.0.1 _0 0 1 0 3kb 0 false true 9.10.0 true