Module elasticsearch::cat

Cat APIs

The Cat APIs aim to meet the needs of humans when looking at data returned from Elasticsearch, formatting it as compact, column aligned text, making it easier on human eyes.

Headers

The column headers to return can be controlled with .h()

let response = client
    .cat()
    .nodes()
    .h(&["ip", "port", "heapPercent", "name"])
    .send()
    .await?;

let response_body = response.read_body::<String>().await?;

Structs

Cat	Namespace client for Cat APIs
CatAliases	Builder for the Cat Aliases API. Shows information about currently configured aliases to indices including filter and routing infos.
CatAllocation	Builder for the Cat Allocation API. Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
CatCount	Builder for the Cat Count API. Provides quick access to the document count of the entire cluster, or individual indices.
CatFielddata	Builder for the Cat Fielddata API. Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
CatHealth	Builder for the Cat Health API. Returns a concise representation of the cluster health.
CatHelp	Builder for the Cat Help API. Returns help for the Cat APIs.
CatIndices	Builder for the Cat Indices API. Returns information about indices: number of primaries and replicas, document counts, disk size, ...
CatMaster	Builder for the Cat Master API. Returns information about the master node.
CatNodeattrs	Builder for the Cat Nodeattrs API. Returns information about custom node attributes.
CatNodes	Builder for the Cat Nodes API. Returns basic statistics about performance of cluster nodes.
CatPendingTasks	Builder for the Cat Pending Tasks API. Returns a concise representation of the cluster pending tasks.
CatPlugins	Builder for the Cat Plugins API. Returns information about installed plugins across nodes node.
CatRecovery	Builder for the Cat Recovery API. Returns information about index shard recoveries, both on-going completed.
CatRepositories	Builder for the Cat Repositories API. Returns information about snapshot repositories registered in the cluster.
CatSegments	Builder for the Cat Segments API. Provides low-level information about the segments in the shards of an index.
CatShards	Builder for the Cat Shards API. Provides a detailed view of shard allocation on nodes.
CatSnapshots	Builder for the Cat Snapshots API. Returns all snapshots in a specific repository.
CatTasks	Builder for the Cat Tasks API. Returns information about the tasks currently executing on one or more nodes in the cluster.
CatTemplates	Builder for the Cat Templates API. Returns information about existing templates.
CatThreadPool	Builder for the Cat Thread Pool API. Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

Enums

CatAliasesParts	API parts for the Cat Aliases API
CatAllocationParts	API parts for the Cat Allocation API
CatCountParts	API parts for the Cat Count API
CatFielddataParts	API parts for the Cat Fielddata API
CatHealthParts	API parts for the Cat Health API
CatHelpParts	API parts for the Cat Help API
CatIndicesParts	API parts for the Cat Indices API
CatMasterParts	API parts for the Cat Master API
CatNodeattrsParts	API parts for the Cat Nodeattrs API
CatNodesParts	API parts for the Cat Nodes API
CatPendingTasksParts	API parts for the Cat Pending Tasks API
CatPluginsParts	API parts for the Cat Plugins API
CatRecoveryParts	API parts for the Cat Recovery API
CatRepositoriesParts	API parts for the Cat Repositories API
CatSegmentsParts	API parts for the Cat Segments API
CatShardsParts	API parts for the Cat Shards API
CatSnapshotsParts	API parts for the Cat Snapshots API
CatTasksParts	API parts for the Cat Tasks API
CatTemplatesParts	API parts for the Cat Templates API
CatThreadPoolParts	API parts for the Cat Thread Pool API