Path parameters

• index string | array[string] Required

  A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

• active_only boolean

  If true, the response only includes ongoing shard recoveries.

• bytes string

  The unit used to display byte values.

  Values are b, kb, mb, gb, tb, or pb.

• detailed boolean

  If true, the response includes detailed information about shard recoveries.

• index string | array[string]

  Comma-separated list or wildcard expression of index names to limit the returned information

• h string | array[string]

  A comma-separated list of columns names to display. It supports simple wildcards.

  Supported values include:

  • index (or i, idx): The name of the index.
  • shard (or s, sh): The name of the shard.
  • time (or t, ti, primaryOrReplica): The recovery time elasped.
  • type: The type of recovery, from a peer or a snapshot.
  • stage (or st): The stage of the recovery. Returned values are: INIT, INDEX: recovery of lucene files, either reusing local ones are copying new ones, VERIFY_INDEX: potentially running check index, TRANSLOG: starting up the engine, replaying the translog, FINALIZE: performing final task after all translog ops have been done, DONE
  • source_host (or shost): The host address the index is moving from.
  • source_node (or snode): The node name the index is moving from.
  • target_host (or thost): The host address the index is moving to.
  • target_node (or tnode): The node name the index is moving to.
  • repository (or tnode): The name of the repository being used. if not relevant 'n/a'.
  • snapshot (or snap): The name of the snapshot being used. if not relevant 'n/a'.
  • files (or f): The total number of files to recover.
  • files_recovered (or fr): The number of files currently recovered.
  • files_percent (or fp): The percentage of files currently recovered.
  • files_total (or tf): The total number of files.
  • bytes (or b): The total number of bytes to recover.
  • bytes_recovered (or br): Total number of bytes currently recovered.
  • bytes_percent (or bp): The percentage of bytes currently recovered.
  • bytes_total (or tb): The total number of bytes.
  • translog_ops (or to): The total number of translog ops to recover.
  • translog_ops_recovered (or tor): The total number of translog ops currently recovered.
  • translog_ops_percent (or top): The percentage of translog ops currently recovered.
  • start_time (or start): The start time of the recovery operation.
  • start_time_millis (or start_millis): The start time of the recovery operation in eopch milliseconds.
  • stop_time (or stop): The end time of the recovery operation. If ongoing '1970-01-01T00:00:00.000Z'
  • stop_time_millis (or stop_millis): The end time of the recovery operation in eopch milliseconds. If ongoing '0'

  Values are index, i, idx, shard, s, sh, time, t, ti, primaryOrReplica, type, stage, st, source_host, shost, source_node, snode, target_host, thost, target_node, tnode, repository, snapshot, snap, files, f, files_recovered, fr, files_percent, fp, files_total, tf, bytes, b, bytes_recovered, br, bytes_percent, bp, bytes_total, tb, translog_ops, to, translog_ops_recovered, tor, translog_ops_percent, top, start_time, start, start_time_millis, start_millis, stop_time, stop, stop_time_millis, or stop_millis.

• s string | array[string]

  A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

• time string

  The unit used to display time values.

  Values are nanos, micros, ms, s, m, h, or d.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • index string
  • shard string

    The shard name.

  • start_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • start_time_millis number

    Time unit for milliseconds

  • stop_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • stop_time_millis number

    Time unit for milliseconds

  • time string

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • type string

    The recovery type.

  • stage string

    The recovery stage.

  • source_host string

    The source host.

  • source_node string

    The source node name.

  • target_host string

    The target host.

  • target_node string

    The target node name.

  • repository string

    The repository name.

  • snapshot string

    The snapshot name.

  • files string

    The number of files to recover.

  • files_recovered string

    The files recovered.

  • files_percent string | number

    One of:

    string-1 string number-2 number
  • files_total string

    The total number of files.

  • bytes string

    The number of bytes to recover.

  • bytes_recovered string

    The bytes recovered.

  • bytes_percent string | number

    One of:

    string-1 string number-2 number
  • bytes_total string

    The total number of bytes.

  • translog_ops string

    The number of translog operations to recover.

  • translog_ops_recovered string

    The translog operations recovered.

  • translog_ops_percent string | number

    One of:

    string-1 string number-2 number