4
4
<titleabbrev>Index recovery</titleabbrev>
5
5
++++
6
6
7
-
8
- Returns information about ongoing and completed shard recoveries for one or more
9
- indices. For data streams, the API returns information for the stream's backing
10
- indices.
7
+ Returns information about ongoing and completed shard recoveries for one or
8
+ more indices. For data streams, the API returns information for the stream's
9
+ backing indices.
11
10
12
11
[source,console]
13
12
----
@@ -33,14 +32,14 @@ index, or alias.
33
32
[[index-recovery-api-desc]]
34
33
==== {api-description-title}
35
34
36
- Use the index recovery API
37
- to get information about ongoing and completed shard recoveries.
35
+ Use the index recovery API to get information about ongoing and completed shard
36
+ recoveries.
38
37
39
38
// tag::shard-recovery-desc[]
40
- Shard recovery is the process
41
- of syncing a replica shard from a primary shard.
42
- Upon completion,
43
- the replica shard is available for search .
39
+ Shard recovery is the process of initializing a shard copy, such as restoring a
40
+ primary shard from a snapshot or syncing a replica shard from a primary shard.
41
+ When a shard recovery completes, the recovered shard is available for search
42
+ and indexing .
44
43
45
44
Recovery automatically occurs during the following processes:
46
45
@@ -52,6 +51,14 @@ Recovery automatically occurs during the following processes:
52
51
<<indices-split-index,split>> operation.
53
52
// end::shard-recovery-desc[]
54
53
54
+ The index recovery API reports information about completed recoveries only for
55
+ shard copies that currently exist in the cluster. It only reports the last
56
+ recovery for each shard copy and does not report historical information about
57
+ earlier recoveries, nor does it report information about the recoveries of
58
+ shard copies that no longer exist. This means that if a shard copy completes a
59
+ recovery and then {es} relocates it onto a different node then the information
60
+ about the original recovery will not be shown in the recovery API.
61
+
55
62
[[index-recovery-api-path-params]]
56
63
==== {api-path-parms-title}
57
64
0 commit comments