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.

• time string

  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:

    _types:DateTime string _types: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:

    _types:DateTime string _types: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:

    _types:Percentage string _types:Percentage 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:

    _types:Percentage string _types:Percentage 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:

    _types:Percentage string _types:Percentage number