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