Get information about all currently running reindex tasks
- GET /_reindex
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
-
detailedboolean · default: false If
true, include detailed task status information in the response.
Response
-
reindexReindexTaskInforequired -
The list of currently running reindex tasks.
-
idstring TaskIdrequired -
The ID of the reindex task. The ID is assigned when the task was first created and remains the same across graceful shutdown relocations.
-
descriptionstring -
A sanitized description of the reindex operation (source and destination indices, and optionally remote host info).
-
start_time_in_millisEpochTimeUnitMillisrequired -
The time at which the reindex task started, in milliseconds since the Unix epoch. Remains the same across graceful shutdown relocations.
-
start_timestring -
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=truequery parameter. -
running_timestring Duration -
The elapsed running time of the reindex task, including relocations, in a human-readable format. Only present when the request includes the
?human=truequery parameter. -
running_time_in_nanosDurationValueUnitNanosrequired -
The elapsed running time of the reindex task, including relocations, in nanoseconds.
-
cancelledbooleanrequired -
Whether the reindex task has been cancelled.
-
statusReindexStatus -
The current progress of the reindex operation.
-
slice_idnumber -
The slice ID
-
batchesnumberrequired -
The number of scroll responses pulled back by the reindex.
-
creatednumber -
The number of documents that were successfully created.
-
deletednumberrequired -
The number of documents that were successfully deleted.
-
noopsnumberrequired -
The number of documents that were ignored because the script used for the reindex returned a
noopvalue forctx.op. -
requests_per_secondnumberrequired -
The number of requests per second effectively executed during the reindex.
-
retriesRetriesrequired -
The number of retries attempted by reindex.
bulkis the number of bulk actions retried andsearchis the number of search actions retried. -
throttledstring Duration -
throttled_millisDurationValueUnitMillisrequired -
Number of milliseconds the request slept to conform to
requests_per_second. -
throttled_untilstring Duration -
throttled_until_millisDurationValueUnitMillisrequired -
This field should always be equal to zero in a
_reindexresponse. 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 torequests_per_second. -
totalnumberrequired -
The number of documents that were successfully processed.
-
updatednumber -
The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.
-
version_conflictsnumberrequired -
The number of version conflicts that reindex hits.
-
cancelledstring -
The reason for cancellation if the slice was canceled
-
task_failuresTaskFailure -
Per-task failures encountered while listing reindex tasks. Tasks that failed are not included in the
reindexarray. -
task_idnumberrequired -
node_idstringrequired -
statusstringrequired -
reasonErrorCauserequired -
typestringrequired -
The type of error
-
reasonstringnullable -
A human-readable explanation of the error, in English.
-
stack_tracestring -
The server stack trace. Present only if the
error_trace=trueparameter was sent with the request. -
caused_byErrorCause -
root_causeErrorCause -
suppressedErrorCause -
node_failuresErrorCause -
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
reindexarray for the duration of the disruption. -
typestringrequired -
The type of error
-
reasonstringnullable -
A human-readable explanation of the error, in English.
-
stack_tracestring -
The server stack trace. Present only if the
error_trace=trueparameter was sent with the request. -
caused_byErrorCause -
root_causeErrorCause -
suppressedErrorCause