CAT recovery

Introduced 1.0

The CAT recovery operation lists all completed and ongoing index and shard recoveries.

Path and HTTP methods

  1. GET _cat/recovery

URL parameters

All CAT recovery URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameters:

ParameterTypeDescription
active_onlyBooleanWhether to only include ongoing shard recoveries. Default is false.
bytesByte sizeSpecify the units for byte size. For example, 7kb or 6gb. For more information, see Supported units.
detailedBooleanWhether to include detailed information about shard recoveries. Default is false.
timeTimeSpecify the units for time. For example, 5d or 7h. For more information, see Supported units.

Example requests

  1. GET _cat/recovery?v

copy

To see only the recoveries of a specific index, add the index name after your query.

  1. GET _cat/recovery/<index>?v

copy

If you want to get information for more than one index, separate the indexes with commas:

  1. GET _cat/recovery/index1,index2,index3

copy

Example response

  1. index | shard | time | type | stage | source_host | source_node | target_host | target_node | repository | snapshot | files | files_recovered | files_percent | files_total | bytes | bytes_recovered | bytes_percent | bytes_total | translog_ops | translog_ops_recovered | translog_ops_percent
  2. movies | 0 | 117ms | empty_store | done | n/a | n/a | 172.18.0.4 | odfe-node1 | n/a | n/a | 0 | 0 | 0.0% | 0 | 0 | 0 | 0.0% | 0 | 0 | 0 | 100.0%
  3. movies | 0 | 382ms | peer | done | 172.18.0.4 | odfe-node1 | 172.18.0.3 | odfe-node2 | n/a | n/a | 1 | 1 |  100.0% | 1 | 208 | 208 | 100.0% | 208 | 1 | 1 | 100.0%