File tree 3 files changed +46
-1
lines changed
rest-api-spec/src/main/resources/rest-api-spec/api
3 files changed +46
-1
lines changed Original file line number Diff line number Diff line change @@ -13,6 +13,8 @@ to the <<indices-recovery, indices recovery>> API.
13
13
14
14
`GET /_cat/recovery/<index>`
15
15
16
+ `GET /_cat/recovery`
17
+
16
18
17
19
[[cat-recovery-api-desc]]
18
20
==== {api-description-title}
@@ -37,14 +39,20 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
37
39
[[cat-recovery-query-params]]
38
40
==== {api-query-parms-title}
39
41
42
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=active-only]
43
+
40
44
include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes]
41
45
46
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=detailed]
47
+
42
48
include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
43
49
44
50
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
45
51
46
52
include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
47
53
54
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=index-query-parm]
55
+
48
56
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
49
57
50
58
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
Original file line number Diff line number Diff line change 1
1
2
+ tag::active-only[]
3
+ `active_only` ::
4
+ (Optional, boolean)
5
+ If `true` ,
6
+ the response only includes ongoing shard recoveries.
7
+ Defaults to `false` .
8
+ end::active-only[]
9
+
2
10
tag::index-alias[]
3
11
Comma-separated list or wildcard expression of index alias names
4
12
used to limit the request.
@@ -67,6 +75,14 @@ tag::default_operator[]
67
75
Defaults to `OR` .
68
76
end::default_operator[]
69
77
78
+ tag::detailed[]
79
+ `detailed` ::
80
+ (Optional, boolean)
81
+ If `true` ,
82
+ the response includes detailed information about shard recoveries.
83
+ Defaults to `false` .
84
+ end::detailed[]
85
+
70
86
tag::df[]
71
87
`df` ::
72
88
(Optional, string) Field to use as default where no field prefix is
@@ -227,6 +243,13 @@ tag::include-unloaded-segments[]
227
243
that are **not** loaded into memory. Defaults to `false` .
228
244
end::include-unloaded-segments[]
229
245
246
+ tag::index-query-parm[]
247
+ `index` ::
248
+ (Optional, string)
249
+ Comma-separated list or wildcard expression of index names
250
+ used to limit the request.
251
+ end::index-query-parm[]
252
+
230
253
tag::index[]
231
254
`<index>` ::
232
255
(Optional, string) Comma-separated list or wildcard expression of index names
Original file line number Diff line number Diff line change 21
21
"parts" :{
22
22
"index" :{
23
23
"type" :" list" ,
24
- "description" :" A comma -separated list of index names to limit the returned information"
24
+ "description" :" Comma -separated list or wildcard expression of index names to limit the returned information"
25
25
}
26
26
}
27
27
}
32
32
"type" :" string" ,
33
33
"description" :" a short version of the Accept header, e.g. json, yaml"
34
34
},
35
+ "active_only" :{
36
+ "type" :" boolean" ,
37
+ "description" :" If `true`, the response only includes ongoing shard recoveries" ,
38
+ "default" :false
39
+ },
35
40
"bytes" :{
36
41
"type" :" enum" ,
37
42
"description" :" The unit in which to display byte values" ,
49
54
" pb"
50
55
]
51
56
},
57
+ "detailed" :{
58
+ "type" :" boolean" ,
59
+ "description" :" If `true`, the response includes detailed information about shard recoveries" ,
60
+ "default" :false
61
+ },
52
62
"master_timeout" :{
53
63
"type" :" time" ,
54
64
"description" :" Explicit operation timeout for connection to master node"
62
72
"description" :" Return help information" ,
63
73
"default" :false
64
74
},
75
+ "index" :{
76
+ "type" :" list" ,
77
+ "description" :" Comma-separated list or wildcard expression of index names to limit the returned information"
78
+ },
65
79
"s" :{
66
80
"type" :" list" ,
67
81
"description" :" Comma-separated list of column names or column aliases to sort by"
You can’t perform that action at this time.
0 commit comments