Get information about all currently running reindex tasks

  • GET /_reindex
Auth

Reindex tasks that are mid-relocation between nodes are reported once, under their original task ID, so callers do not see duplicates across the relocation chain.

If the API returns a HTTP status of 200 OK, but node_failures or task_failures are non-empty in the body, the listing is not a complete authoritative listing and may be missing tasks.

Query parameters

detailed boolean · default: false

If true, include detailed task status information in the response.

Response

application/json
reindex object[] required

The list of currently running reindex tasks.

id string required

The ID of the reindex task. The ID is assigned when the task was first created and remains the same across graceful shutdown relocations.

description string

A sanitized description of the reindex operation (source and destination indices, and optionally remote host info).

start_time_in_millis number required

The time at which the reindex task started, in milliseconds since the Unix epoch. Remains the same across graceful shutdown relocations.

start_time string

The time at which the reindex task started, as an ISO-8601 formatted string. Remains the same across graceful shutdown relocations. Only present when the request includes the ?human=true query parameter.

running_time string

The elapsed running time of the reindex task, including relocations, in a human-readable format. Only present when the request includes the ?human=true query parameter.

running_time_in_nanos number required

The elapsed running time of the reindex task, including relocations, in nanoseconds.

cancelled boolean required

Whether the reindex task has been cancelled.

status object

The current progress of the reindex operation.

slice_id number

The slice ID

batches number required

The number of scroll responses pulled back by the reindex.

created number

The number of documents that were successfully created.

deleted number required

The number of documents that were successfully deleted.

noops number required

The number of documents that were ignored because the script used for the reindex returned a noop value for ctx.op.

requests_per_second number required

The number of requests per second effectively executed during the reindex.

retries object required

The number of retries attempted by reindex. bulk is the number of bulk actions retried and search is the number of search actions retried.

bulk number required

The number of bulk actions retried.

The number of search actions retried.

throttled string
throttled_millis number required

Number of milliseconds the request slept to conform to requests_per_second.

throttled_until string
throttled_until_millis number required

This field should always be equal to zero in a _reindex response. It only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to requests_per_second.

total number required

The number of documents that were successfully processed.

updated number

The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.

version_conflicts number required

The number of version conflicts that reindex hits.

cancelled string

The reason for cancellation if the slice was canceled

task_failures object[]

Per-task failures encountered while listing reindex tasks. Tasks that failed are not included in the reindex array.

task_id number required
node_id string required
status string required
reason object required
type string required

The type of error

reason union string nullable

A human-readable explanation of the error, in English.

One of: string
stack_trace string

The server stack trace. Present only if the error_trace=true parameter was sent with the request.

caused_by object
Same fields as reason in task_failures
root_cause object[]
Same fields as reason in task_failures
suppressed object[]
Same fields as reason in task_failures
node_failures object[]

Node-level failures encountered while listing reindex tasks. Typically populated when a node disconnects or stops responding mid-request, reindex tasks running on such nodes will be missing from the reindex array for the duration of the disruption.

type string required

The type of error

reason union string nullable

A human-readable explanation of the error, in English.

One of: string
stack_trace string

The server stack trace. Present only if the error_trace=true parameter was sent with the request.

caused_by object
Same fields as node_failures
root_cause object[]
Same fields as node_failures
suppressed object[]
Same fields as node_failures