@@ -62,6 +62,93 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=detailed]
6262include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
6363
6464include::{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) **Not too sure, need to investigate
87+
88+ `source_host`, `shost`::
89+ (Default) Host address the index is moving from.
90+
91+ `source_node`, `snode`::
92+ (Default) Node name the index is moving from.
93+
94+ `target_host`, `thost`::
95+ (Default) Host address the index is moving to.
96+
97+ `target_node`, `tnode`::
98+ (Default) Node name the index is moving to.
99+
100+ `repository`, `rep`::
101+ (Default) Name of the repository being used. if not relevant `n/a`.
102+
103+ `snapshot`, `snap`::
104+ (Default) Name of the snapshot being used. if not relevant `n/a`.
105+
106+ `files`, `f`::
107+ (Default) Total number of files to recover.
108+
109+ `files_recovered`, `fr`::
110+ (Default) Number of files currently recovered.
111+
112+ `files_percent`, `fp`::
113+ (Default) Percentage of files currently recovered.
114+
115+ `files_total`, `tf`::
116+ (Default) Total number of files.
117+
118+ `bytes`, `b`::
119+ (Default) Total number of bytes to recover.
120+
121+ `bytes_recovered`, `br`::
122+ (Default) Total number of bytes currently recovered.
123+
124+ `bytes_percent`, `bp`::
125+ (Default) Percentage of bytes currently recovered.
126+
127+ `bytes_total`, `tb`::
128+ (Default) Total number of bytes.
129+
130+ `translog_ops`, `to`::
131+ (Default) Total number of translog ops to recover.
132+
133+ `translog_ops_recovered`, `tor`::
134+ (Default) Total number of translog ops currently recovered.
135+
136+ `translog_ops_percent`, `top`::
137+ (Default) Percentage of translog ops currently recovered.
138+
139+ `start_time`, `start`::
140+ Start time of the recovery operation.
141+
142+ `start_time_millis`, `start_millis`::
143+ Start time of the recovery operation in eopch milliseconds.
144+
145+ `stop_time`, `stop`::
146+ End time of the recovery operation. If ongoing `1970-01-01T00:00:00.000Z`
147+
148+ `stop_time_millis`, `stop_millis`::
149+ End time of the recovery operation in eopch milliseconds. If ongoing `0`
150+
151+ --
65152
66153include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
67154
@@ -152,4 +239,4 @@ The API returns the following response with a recovery type of `snapshot`:
152239i s t ty st rep snap f fp b bp
153240my-index-000001 0 1978ms snapshot done my-repo snap-1 79 8.0% 12086 9.0%
154241--------------------------------------------------------------------------------
155- // TESTRESPONSE[non_json]
242+ // TESTRESPONSE[non_json]
0 commit comments