@@ -62,6 +62,101 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=detailed]
62
62
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
63
63
64
64
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
65
+ +
66
+ --
67
+ If you do not specify which columns to include, the API returns the default
68
+ columns in the order listed below. If you explicitly specify one or more
69
+ columns, it only returns the specified columns.
70
+
71
+ Valid columns are:
72
+
73
+ `index`, `i`, `idx`::
74
+ (Default) Name of the index.
75
+
76
+ `shard`, `s`, `sh`::
77
+ (Default) Name of the shard.
78
+
79
+ `time`, `t`, `ti`, `primaryOrReplica`::
80
+ (Default) Recovery time elasped.
81
+
82
+ `type`, `ty`::
83
+ (Default) Type of recovery, from a `peer` or a `snapshot`.
84
+
85
+ `stage`, `st`::
86
+ (Default) Stage of the recovery.
87
+ Returned values are:
88
+ +
89
+ * `INIT`
90
+ * `INDEX` recovery of lucene files, either reusing local ones are copying new ones
91
+ * `VERIFY_INDEX` potentially running check index
92
+ * `TRANSLOG` starting up the engine, replaying the translog
93
+ * `FINALIZE` performing final task after all translog ops have been done
94
+ * `DONE`
95
+
96
+ `source_host`, `shost`::
97
+ (Default) Host address the index is moving from.
98
+
99
+ `source_node`, `snode`::
100
+ (Default) Node name the index is moving from.
101
+
102
+ `target_host`, `thost`::
103
+ (Default) Host address the index is moving to.
104
+
105
+ `target_node`, `tnode`::
106
+ (Default) Node name the index is moving to.
107
+
108
+ `repository`, `rep`::
109
+ (Default) Name of the repository being used. if not relevant `n/a`.
110
+
111
+ `snapshot`, `snap`::
112
+ (Default) Name of the snapshot being used. if not relevant `n/a`.
113
+
114
+ `files`, `f`::
115
+ (Default) Total number of files to recover.
116
+
117
+ `files_recovered`, `fr`::
118
+ (Default) Number of files currently recovered.
119
+
120
+ `files_percent`, `fp`::
121
+ (Default) Percentage of files currently recovered.
122
+
123
+ `files_total`, `tf`::
124
+ (Default) Total number of files.
125
+
126
+ `bytes`, `b`::
127
+ (Default) Total number of bytes to recover.
128
+
129
+ `bytes_recovered`, `br`::
130
+ (Default) Total number of bytes currently recovered.
131
+
132
+ `bytes_percent`, `bp`::
133
+ (Default) Percentage of bytes currently recovered.
134
+
135
+ `bytes_total`, `tb`::
136
+ (Default) Total number of bytes.
137
+
138
+ `translog_ops`, `to`::
139
+ (Default) Total number of translog ops to recover.
140
+
141
+ `translog_ops_recovered`, `tor`::
142
+ (Default) Total number of translog ops currently recovered.
143
+
144
+ `translog_ops_percent`, `top`::
145
+ (Default) Percentage of translog ops currently recovered.
146
+
147
+ `start_time`, `start`::
148
+ Start time of the recovery operation.
149
+
150
+ `start_time_millis`, `start_millis`::
151
+ Start time of the recovery operation in eopch milliseconds.
152
+
153
+ `stop_time`, `stop`::
154
+ End time of the recovery operation. If ongoing `1970-01-01T00:00:00.000Z`
155
+
156
+ `stop_time_millis`, `stop_millis`::
157
+ End time of the recovery operation in eopch milliseconds. If ongoing `0`
158
+
159
+ --
65
160
66
161
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
67
162
@@ -152,4 +247,4 @@ The API returns the following response with a recovery type of `snapshot`:
152
247
i s t ty st rep snap f fp b bp
153
248
my-index-000001 0 1978ms snapshot done my-repo snap-1 79 8.0% 12086 9.0%
154
249
--------------------------------------------------------------------------------
155
- // TESTRESPONSE[non_json]
250
+ // TESTRESPONSE[non_json]
0 commit comments