Get the status and progress of a specific reindex task
- GET /_reindex/{task_id}
This API follows reindex tasks across node-shutdown relocations, so callers can keep using the original task ID throughout the lifetime of the operation. Returned task IDs and timings reflect the original task, not its relocated successor. Relocated task IDs are also supported. They are followed transparently and return the task ID and timings of the original task.
When the task ID cannot be resolved, the API returns the response below with a 404 status code. This response is used whether the ID is unknown, refers to a non-reindex task, refers to a sliced child subtask, or refers to a task whose node left the cluster with no stored result (e.g. a non-graceful shutdown).
{
"error": {
"type": "resource_not_found_exception",
"reason": "Reindex operation [r1A2WoRbTwKZ516z6NEs5A:36619] not found"
},
"status": 404
}
Path Parameters
-
task_idstring TaskIdrequired -
The ID of the reindex task to retrieve.
Query Parameters
-
wait_for_completionboolean · default: false If
true, the request blocks until the reindex task completes, then returns the result.-
timeoutstring Duration · default: 30s The period to wait for the reindex task to complete when
wait_for_completionistrue.
Response
-
completedbooleanrequired -
Whether the reindex task has completed.
-
idstring TaskIdrequired -
The ID of the reindex task. The value is the ID assigned when the task was first created and remains stable across node-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.
-
start_timestring -
The time at which the reindex task started, as an ISO 8601 formatted string. Only present when the request includes the
?human=truequery parameter. -
running_timestring Duration -
The elapsed running time of the reindex task, 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, 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
-
errorErrorCause -
The error that caused the reindex task to fail, if any.
-
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 -
responseReindexTaskResult -
The final result of the completed reindex operation, if the task has finished successfully.
-
batchesnumber -
The number of scroll responses pulled back by the reindex.
-
creatednumber -
The number of documents that were successfully created.
-
deletednumber -
The number of documents that were successfully deleted.
-
failuresBulkIndexByScrollFailure -
Any failures encountered during the reindex. If non-empty, the reindex ended because of these failures.
-
causeErrorCauserequired -
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 -
idstring Idrequired -
indexstring IndexNamerequired -
statusnumberrequired -
noopsnumber -
The number of documents that were ignored because the script returned a
noopvalue forctx.op. -
requests_per_secondnumber -
The number of requests per second effectively executed during the reindex.
-
retriesRetries -
The number of retries attempted by reindex.
-
throttled_millisDurationValueUnitMillis -
Number of milliseconds the request slept to conform to
requests_per_second. -
throttled_until_millisDurationValueUnitMillis -
This field should always be equal to zero in a completed reindex result.
-
timed_outboolean -
Whether any of the requests executed during the reindex timed out.
-
tookDurationValueUnitMillis -
The total milliseconds the entire operation took.
-
totalnumber -
The number of documents that were successfully processed.
-
updatednumber -
The number of documents that were successfully updated.
-
version_conflictsnumber -
The number of version conflicts that occurred.