Get shard recovery information

GET /_cat/recovery/{index}
GET /_cat/recovery

Auth

Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

Required authorization

Index privileges monitor
Cluster privileges monitor

Path parameters

index union string | string[] optional

A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Leave it out to use /_cat/recovery.

Query parameters

active_only boolean · default: false

If true, the response only includes ongoing shard recoveries.

detailed boolean · default: false

If true, the response includes detailed information about shard recoveries.

index union string | string[]

Comma-separated list or wildcard expression of index names to limit the returned information

h union oneOf · default: ip,hp,rp,r,m,n,cpu,l

A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:

index (or i, idx): The name of the index.
shard (or s, sh): The name of the shard.
time (or t, ti, primaryOrReplica): The recovery time elasped.
type: The type of recovery, from a peer or a snapshot.
stage (or st): The stage of the recovery. Returned values are: INIT, INDEX: recovery of lucene files, either reusing local ones are copying new ones, VERIFY_INDEX: potentially running check index, TRANSLOG: starting up the engine, replaying the translog, FINALIZE: performing final task after all translog ops have been done, DONE
source_host (or shost): The host address the index is moving from.
source_node (or snode): The node name the index is moving from.
target_host (or thost): The host address the index is moving to.
target_node (or tnode): The node name the index is moving to.
repository (or tnode): The name of the repository being used. if not relevant 'n/a'.
snapshot (or snap): The name of the snapshot being used. if not relevant 'n/a'.
files (or f): The total number of files to recover.
files_recovered (or fr): The number of files currently recovered.
files_percent (or fp): The percentage of files currently recovered.
files_total (or tf): The total number of files.
bytes (or b): The total number of bytes to recover.
bytes_recovered (or br): Total number of bytes currently recovered.
bytes_percent (or bp): The percentage of bytes currently recovered.
bytes_total (or tb): The total number of bytes.
translog_ops (or to): The total number of translog ops to recover.
translog_ops_recovered (or tor): The total number of translog ops currently recovered.
translog_ops_percent (or top): The percentage of translog ops currently recovered.
start_time (or start): The start time of the recovery operation.
start_time_millis (or start_millis): The start time of the recovery operation in eopch milliseconds.
stop_time (or stop): The end time of the recovery operation. If ongoing '1970-01-01T00:00:00.000Z'
stop_time_millis (or stop_millis): The end time of the recovery operation in eopch milliseconds. If ongoing '0'

Values: index i idx shard s sh time t ti primaryOrReplica type stage st source_host shost source_node snode target_host thost target_node tnode repository snapshot snap files f files_recovered fr files_percent fp files_total tf bytes b bytes_recovered br bytes_percent bp bytes_total tb translog_ops to translog_ops_recovered tor translog_ops_percent top start_time start start_time_millis start_millis stop_time stop stop_time_millis stop_millis

s union string | string[]

A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

format string · default: text

Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

help boolean · default: false

When set to true will output available columns. This option can't be combined with any other query string option.

v boolean · default: false

When set to true will enable verbose output.

bytes enum

Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

Values: b kb mb gb tb pb

time enum

Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

Values: nanos micros ms s m h d

Response

application/json

<array> object[]