Batch start or resume reindex API

The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental.

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 executed one-by-one, which ensures that minimal cluster resources are consumed over time.

Request

POST /api/upgrade_assistant/reindex/batch

Request body

indexNames

(Required, array) The list of index names to be reindexed.

Response code

200

Indicates a successful call.

Example

  1. $ curl -X POST api/upgrade_assistant/reindex/batch
  2. {
  3.   "indexNames": [ 
  4.     "index1",
  5.     "index2"
  6.   ]
  7. }

The order of the indices determines the order that the reindex tasks are executed.

Similar to the start or resume endpoint, the API returns the following:

  1. {
  2.   "enqueued": [ 
  3.     {
  4.       "indexName": "index1",
  5.       "newIndexName": "reindexed-v8-index1",
  6.       "status": 3,
  7.       "lastCompletedStep": 0,
  8.       "locked": null,
  9.       "reindexTaskId": null,
  10.       "reindexTaskPercComplete": null,
  11.       "errorMessage": null,
  12.       "runningReindexCount": null,
  13.       "reindexOptions": { 
  14.         "queueSettings": {
  15.           "queuedAt": 1583406985489 
  16.         }
  17.       }
  18.     }
  19.   ],
  20.   "errors": [ 
  21.     {
  22.       "indexName": "index2",
  23.       "message": "Something went wrong!"
  24.     }
  25.   ]
  26. }

A list of reindex operations created, the order in the array indicates the order in which tasks will be executed.

Presence of this key indicates that the reindex job will occur in the batch.

A Unix timestamp of when the reindex task was placed in the queue.

A list of errors that may have occurred preventing the reindex task from being created.

Most Popular