CAT recovery - OpenSearch Documentation
CAT recovery | OpenSearch Documentation
OpenSearch
About
Releases
Roadmap
FAQ
Platform
Observability
Security Analytics
Vector Database
Playground Demo
Performance Benchmarks
Community
Forum
Slack
Events
Solutions Providers
Projects
Members
Documentation
OpenSearch and Dashboards
Data Prepper
Clients
Benchmark
Migration Assistant
Blog
Documentation
CAT Recovery API
Introduced 1.0
The CAT recovery operation lists all completed and ongoing index and shard recoveries.
Endpoints
GET
/_cat/recovery
GET
/_cat/recovery/
index
Query parameters
The following table lists the available query parameters. All query parameters are optional.
Parameter
Data type
Description
Default
active_only
Boolean
If
true
, the response only includes ongoing shard recoveries.
false
bytes
String
The units used to display byte values.
Valid values are:
kb
mb
gb
tb
pb
, and
N/A
detailed
Boolean
When
true
, includes detailed information about shard recoveries.
false
format
String
A short version of the
Accept
header, such as
json
or
yaml
N/A
List
A comma-separated list of column names to display.
N/A
help
Boolean
Returns help information.
false
index
List
A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (
). To target all data streams and indexes, omit this parameter or use
or
_all
N/A
List
A comma-separated list of column names or column aliases to sort by.
N/A
time
String
Specifies the time units, for example,
5d
or
7h
. For more information, see
Supported units
Valid values are:
nanos
micros
ms
, and
N/A
Boolean
Enables verbose mode, which displays column headers.
false
Example requests
GET
/_cat/recovery?v
response
client
cat
recovery
params
true
To see only the recoveries of a specific index, add the index name after your query.
GET
/_cat/recovery/
response
client
cat
recovery
index
params
true
If you want to get information for more than one index, separate the indexes with commas:
GET
/_cat/recovery/index
,index
,index
response
client
cat
recovery
index
index1,index2,index3
Example response
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
movies
117
ms
empty_store
done
n/a
n/a
172.18
0.4
odfe-node
n/a
n/a
0.0
0.0
100.0
movies
382
ms
peer
done
172.18
0.4
odfe-node
172.18
0.3
odfe-node
n/a
n/a
100.0
208
208
100.0
208
100.0
Endpoints
Query parameters
Example requests
Example response
WAS THIS PAGE HELPFUL?
✔ Yes
✖ No
Tell us why
350 characters left
Thank you for your feedback!
Have a question?
Ask us on the OpenSearch forum
Want to contribute?
Edit this page
or
create an issue
OpenSearch Links
Get Involved
Code of Conduct
Forum
GitHub
Slack
Resources
About
Release Schedule
Maintenance Policy
FAQ
Testimonials
Trademark and Brand Policy
Connect
Meetup
Copyright © OpenSearch Project a Series of LF Projects, LLC
For web site terms of use, trademark policy and other project policies please see
US