Batch start or resume reindexing
https://{kibana_url}
- POST /api/upgrade_assistant/reindex/batch
Start or resume multiple reindexing tasks in one request. Additionally, reindexing tasks started or resumed via the batch endpoint will be placed on a queue and run one-by-one, which ensures that minimal cluster resources are consumed over time.
Request
-
indexNamesstringrequired -
The list of index names to be reindexed. The order of the indices determines the order that the reindex tasks are run.
Response
Indicates a successful call.
-
enqueuedobject -
A list of reindex tasks created. The order in the array indicates the order in which tasks will be run.
-
errorMessagestring -
The error that caused the reindex to fail, if it failed.
-
indexNamestring -
The name of the old index.
-
lastCompletedStepinteger -
The last successfully completed step of the reindex. For example:
0: The reindex task has been created in Kibana. -10: The index group services stopped. Only applies to some system indices. -20: The index is set to readonly. -30: The new destination index has been created. -40: The reindex task in Elasticsearch has started. -50: The reindex task in Elasticsearch has completed. -60: Aliases were created to point to the new index, and the old index has been deleted. -70: The index group services have resumed. Only applies to some system indices.
-
lockedstring -
reindexOptions -
The presence of this key indicates that the reindex job will occur in the batch.
-
queueSettingsobject -
queuedAtnumber -
A Unix timestamp of when the reindex task was placed in the queue.
-
reindexTaskIdstring -
The task ID of the reindex task in Elasticsearch. This value appears when the reindexing starts.
-
reindexTaskPercCompletenumber -
The progress of the reindexing task in Elasticsearch. It appears in decimal form, from 0 to 1.
-
runningReindexCountnumber -
errorsobject -
A list of errors that may have occurred preventing the reindex task from being created.