Returns 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.
Path parameters
-
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
.
Query parameters
-
active_only boolean
If
true
, the response only includes ongoing shard recoveries. -
bytes string
The unit used to display byte values.
Values are
b
,kb
,mb
,gb
,tb
, orpb
. -
detailed boolean
If
true
, the response includes detailed information about shard recoveries.
curl \
-X GET http://api.example.com/_cat/recovery/{index}
[
{
"index": "string",
"shard": "string",
"": "string",
"time": "string",
"type": "string",
"stage": "string",
"source_host": "string",
"source_node": "string",
"target_host": "string",
"target_node": "string",
"repository": "string",
"snapshot": "string",
"files": "string",
"files_recovered": "string",
"files_total": "string",
"bytes": "string",
"bytes_recovered": "string",
"bytes_total": "string",
"translog_ops": "string",
"translog_ops_recovered": "string"
}
]