Batch reindex queue API

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

Check the current reindex batch queue.

Request

GET /api/upgrade_assistant/reindex/batch/queue

Response code

200

Indicates a successful call.

Example

The API returns the following:

  1. {
  2.   "queue": [ 
  3.     {
  4.       "indexName": "index1",
  5.       "newIndexName": "reindexed-v8-index2",
  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.       "indexName": "index2",
  21.       "newIndexName": "reindexed-v8-index2",
  22.       "status": 3,
  23.       "lastCompletedStep": 0,
  24.       "locked": null,
  25.       "reindexTaskId": null,
  26.       "reindexTaskPercComplete": null,
  27.       "errorMessage": null,
  28.       "runningReindexCount": null,
  29.       "reindexOptions": {
  30.         "queueSettings": {
  31.           "queuedAt": 1583406987334
  32.         }
  33.       }
  34.     }
  35.   ]
  36. }

Items in this array indicate reindex tasks at a given point in time and the order in which they will be executed.

Most Popular