@@ -1,5 +1,8 @@
[[cat-alias]]
-=== cat aliases
+=== cat aliases API
+++++
+<titleabbrev>cat aliases</titleabbrev>
Returns information about currently configured aliases to indices, including
filter and routing information.
@@ -1,5 +1,9 @@
[[cat-allocation]]
-=== cat allocation
+=== cat allocation API
+<titleabbrev>cat allocation</titleabbrev>
+
Provides a snapshot of the number of shards allocated to each data node
and their disk space.
[[cat-count]]
-=== cat count
+=== cat count API
+<titleabbrev>cat count</titleabbrev>
Provides quick access to a document count of individual indices or all indices
in a cluster.
[[cat-fielddata]]
-=== cat fielddata
+=== cat fielddata API
+<titleabbrev>cat fielddata</titleabbrev>
Returns the amount of heap memory currently used by fielddata on every data node
in the cluster.
[[cat-health]]
-=== cat health
+=== cat health API
+<titleabbrev>cat health</titleabbrev>
Returns the health status of a cluster, similar to the <<cluster-health,cluster
health>> API.
[[cat-indices]]
-=== cat indices
+=== cat indices API
+<titleabbrev>cat indices</titleabbrev>
Returns high-level information about indices in a cluster.
[[cat-master]]
-=== cat master
+=== cat master API
+<titleabbrev>cat master</titleabbrev>
Returns information about the master node, including the ID, bound IP address,
and name.
[[cat-nodeattrs]]
-=== cat nodeattrs
+=== cat nodeattrs API
+<titleabbrev>cat nodeattrs</titleabbrev>
Returns information about custom node attributes.
[[cat-nodes]]
-=== cat nodes
+=== cat nodes API
+<titleabbrev>cat nodes</titleabbrev>
Returns information about a cluster's nodes.
[[cat-pending-tasks]]
-=== cat pending tasks
+=== cat pending tasks API
+<titleabbrev>cat pending tasks</titleabbrev>
Returns cluster-level changes that have not yet been executed, similar to the
<<cluster-pending, pending cluster tasks>> API.
[[cat-plugins]]
-=== cat plugins
+=== cat plugins API
+<titleabbrev>cat plugins</titleabbrev>
Returns a list of plugins running on each node of a cluster.
[[cat-recovery]]
-=== cat recovery
+=== cat recovery API
+<titleabbrev>cat recovery</titleabbrev>
Returns information about ongoing and completed index shard recoveries, similar
to the <<indices-recovery, indices recovery>> API.
[[cat-repositories]]
-=== cat repositories
+=== cat repositories API
+<titleabbrev>cat repositories</titleabbrev>
Returns the <<snapshots-repositories,snapshot repositories>> for a cluster.
[[cat-segments]]
-=== cat segments
+=== cat segments API
+<titleabbrev>cat segments</titleabbrev>
Returns low-level information about the https://lucene.apache.org/core/[Lucene]
segments in index shards, similar to the <<indices-segments, indices segments>>
[[cat-shards]]
-=== cat shards
+=== cat shards API
+<titleabbrev>cat shards</titleabbrev>
The `shards` command is the detailed view of what nodes contain which
shards. It will tell you if it's a primary or replica, the number of
[[cat-snapshots]]
-=== cat snapshots
+=== cat snapshots API
+<titleabbrev>cat snapshots</titleabbrev>
Returns information about the <<modules-snapshots,snapshots>> stored in one or
more repositories. A snapshot is a backup of an index or running {es} cluster.
[[cat-templates]]
-=== cat templates
+=== cat templates API
+<titleabbrev>cat templates</titleabbrev>
Returns information about <<indices-templates,index templates>> in a cluster.
You can use index templates to apply <<index-modules-settings,index settings>>
[[cat-thread-pool]]
-=== cat thread pool
+=== cat thread pool API
+<titleabbrev>cat thread pool</titleabbrev>
Returns thread pool statistics for each node in a cluster. Returned information
includes all <<modules-threadpool,built-in thread pools>> and custom thread