snapshots
返回存储在一个或多个存储库中的快照信息。使用snapshots需要一个路径参数:逗号分隔的快照存储库id列表,接受通配符表达式。如果在请求期间任何存储库失败,Elasticsearch将返回一个错误。快照存储库id可通过repositories查看。除catAPI公共参数外,还支持两个参数ignore_unavailable和master_timeout。如果ignore_unavailable为true,响应不包含来自不可用快照的信息,默认为false。master_timout指定连接主节点的超时时间。如果超时前没有收到响应,则请求失败并返回错误,默认为30s。可展示的信息如下:
列名 | 简写 | 说明 |
id | snapshot | 快照id。 |
status | s | 快照进程的状态:FAILED(快照进程失败)、INCOMPATIBLE(快照进程与当前集群版本不兼容)、IN_PROGRESS(快照进程已启动,但未完成)、PARTIAL(快照进程部分成功完成)、SUCCESS(快照进程全部成功完成)。 |
start_epoch | ste | 快照进程启动时的Unix时间。 |
start_time | sti | 快照进程启动时的HH:MM:SS格式时间。 |
end_epoch | ete | 快照进程结束时的Unix时间。 |
end_time | eti | 快照进程结束时的HH:MM:SS格式时间。 |
duration | dur | 快照进程所用的时间。 |
indices | i | 索引的数量。 |
successful_shards | ss | 成功分片的数量。 |
failed_shards | fs | 失败分片的数量。 |
total_shards | ts | 分片总数量。 |
reason | r | 失败原因。 |
templates
返回集群中索引模版的信息。templates接受一个可选的路径参数:逗号分隔的索引模版名称列表,接受通配符表达式。如果不使用此路径参数,则返回所有索引模版信息。除catAPI公共参数外,还支持两个参数:local和master_timout。如果local为true,则只从本地节点检索信息,默认为false,从主节点检索信息。master_timout指定连接主节点的超时时间。如果超时前没有收到响应,则请求失败并返回错误,默认为30s。可展示的信息如下:
列名 | 简写 | 说明 |
name | n | 模版名。 |
index_patterns | t | 模板索引模式。 |
order | o | 模版应用顺序。 |
version | v | 版本。 |
count
返回集群中所有或某个索引的文档数量,只统计存活的文档,不包括合并过程中尚未删除的已删除的文档。count接受一个可选的路径参数:逗号分隔的索引名列表,接受通配符表达式。可展示的信息如下:
列名 | 简写 | 说明 |
epoch | t,time | Unix时间。 |
timestamp | ts,hms,hhmmss | HH:MM:SS格式时间。 |
count | dc,docs.count,docsCount | 文档数。 |
aliases
返回当前配置的索引别名信息,包括过滤器和路由信息。aliases接受一个可选的路径参数:逗号分隔的别名列表。可展示的信息如下:
列名 | 简写 | 说明 |
alias | a | 别名。 |
index | i,idx | 索引别名指向。 |
filter | f,fi | 过滤器。 |
routing.index | ri,routingIndex | 索引路由。 |
routing.search | rs,routingSearch | 搜索路由。 |