Get index recovery information

GET /{index}/_recovery

Get information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing indices.

Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.

Recovery automatically occurs during the following processes:

When creating an index for the first time.
When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.
Creation of new replica shard copies from the primary.
Relocation of a shard copy to a different node in the same cluster.
A snapshot restore operation.
A clone, shrink, or split operation.

You can determine the cause of a shard recovery using the recovery or cat recovery APIs.

The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.

Path parameters

index string | array[string] Required

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.
detailed boolean

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

Responses

200 application/json
Hide response attribute Show response attribute object
- * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attribute Show * attribute object
  
  shards array[object] Required
  
  Hide shards attributes Show shards attributes object
  
  id number Required
  
  index object Required
  
  Additional properties are allowed.
  
  Hide index attributes Show index attributes object
  
  bytes object
  
  Additional properties are allowed.
  
  Hide bytes attributes Show bytes attributes object
  
  percent
  
  recovered
  
  recovered_in_bytes
  
  recovered_from_snapshot
  
  recovered_from_snapshot_in_bytes
  
  reused
  
  reused_in_bytes
  
  total
  
  total_in_bytes
  
  files object Required
  
  Additional properties are allowed.
  
  Hide files attributes Show files attributes object
  
  details array[object]
  
  percent
  
  recovered number Required
  
  reused number Required
  
  total number Required
  
  size object Required
  
  Additional properties are allowed.
  
  Hide size attributes Show size attributes object
  
  percent
  
  recovered
  
  recovered_in_bytes
  
  recovered_from_snapshot
  
  recovered_from_snapshot_in_bytes
  
  reused
  
  reused_in_bytes
  
  total
  
  total_in_bytes
  
  source_throttle_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.
  
  source_throttle_time_in_millis number
  
  Time unit for milliseconds
  
  target_throttle_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.
  
  target_throttle_time_in_millis number
  
  Time unit for milliseconds
  
  total_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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  primary boolean Required
  
  source object Required
  
  Additional properties are allowed.
  
  Hide source attributes Show source attributes object
  
  hostname string
  
  host string
  
  transport_address string
  
  id string
  
  ip string
  
  name string
  
  bootstrap_new_history_uuid boolean
  
  repository string
  
  snapshot string
  
  version string
  
  restoreUUID string
  
  index string
  
  stage string Required
  
  start object
  
  Additional properties are allowed.
  
  Hide start attributes Show start attributes object
  
  check_index_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.
  
  check_index_time_in_millis number
  
  Time unit for milliseconds
  
  total_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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  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_in_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_in_millis number
  
  Time unit for milliseconds
  
  target object Required
  
  Additional properties are allowed.
  
  Hide target attributes Show target attributes object
  
  hostname string
  
  host string
  
  transport_address string
  
  id string
  
  ip string
  
  name string
  
  bootstrap_new_history_uuid boolean
  
  repository string
  
  snapshot string
  
  version string
  
  restoreUUID string
  
  index string
  
  total_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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  translog object Required
  
  Additional properties are allowed.
  
  Hide translog attributes Show translog attributes object
  
  percent string | number Required
  
  One of:
  _types:Percentage string _types:Percentage number
  
  recovered number Required
  
  total number Required
  
  total_on_start number Required
  
  total_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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  type string Required
  
  verify_index object Required
  
  Additional properties are allowed.
  
  Hide verify_index attributes Show verify_index attributes object
  
  check_index_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.
  
  check_index_time_in_millis number
  
  Time unit for milliseconds
  
  total_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.
  
  total_time_in_millis number
  
  Time unit for milliseconds

GET /{index}/_recovery

curl \
 -X GET http://api.example.com/{index}/_recovery

Response examples (200)

{
  "index1" : {
    "shards" : [ {
      "id" : 0,
      "type" : "SNAPSHOT",
      "stage" : "INDEX",
      "primary" : true,
      "start_time" : "2014-02-24T12:15:59.716",
      "start_time_in_millis": 1393244159716,
      "stop_time" : "0s",
      "stop_time_in_millis" : 0,
      "total_time" : "2.9m",
      "total_time_in_millis" : 175576,
      "source" : {
        "repository" : "my_repository",
        "snapshot" : "my_snapshot",
        "index" : "index1",
        "version" : "{version}",
        "restoreUUID": "PDh1ZAOaRbiGIVtCvZOMww"
      },
      "target" : {
        "id" : "ryqJ5lO5S4-lSFbGntkEkg",
        "host" : "my.fqdn",
        "transport_address" : "my.fqdn",
        "ip" : "10.0.1.7",
        "name" : "my_es_node"
      },
      "index" : {
        "size" : {
          "total" : "75.4mb",
          "total_in_bytes" : 79063092,
          "reused" : "0b",
          "reused_in_bytes" : 0,
          "recovered" : "65.7mb",
          "recovered_in_bytes" : 68891939,
          "recovered_from_snapshot" : "0b",
          "recovered_from_snapshot_in_bytes" : 0,
          "percent" : "87.1%"
        },
        "files" : {
          "total" : 73,
          "reused" : 0,
          "recovered" : 69,
          "percent" : "94.5%"
        },
        "total_time" : "0s",
        "total_time_in_millis" : 0,
        "source_throttle_time" : "0s",
        "source_throttle_time_in_millis" : 0,
        "target_throttle_time" : "0s",
        "target_throttle_time_in_millis" : 0
      },
      "translog" : {
        "recovered" : 0,
        "total" : 0,
        "percent" : "100.0%",
        "total_on_start" : 0,
        "total_time" : "0s",
        "total_time_in_millis" : 0
      },
      "verify_index" : {
        "check_index_time" : "0s",
        "check_index_time_in_millis" : 0,
        "total_time" : "0s",
        "total_time_in_millis" : 0
      }
    } ]
  }
}