Get the batch reindex queue Technical Preview

GET /api/upgrade_assistant/reindex/batch/queue
Api key auth Basic auth

Check the current reindex batch queue.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attribute Show response attribute object
    • queue array[object]

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

      Hide queue attributes Show queue attributes object
      • errorMessage string

        The error that caused the reindex to fail, if it failed.

      • indexName string

        The name of the old index.

      • lastCompletedStep integer

        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.
      • locked string
      • reindexOptions object

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

        Hide reindexOptions attribute Show reindexOptions attribute object
        • queueSettings object
          Hide queueSettings attribute Show queueSettings attribute object
          • queuedAt number

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

      • reindexTaskId string

        The task ID of the reindex task in Elasticsearch. This value appears when the reindexing starts.

      • reindexTaskPercComplete number

        The progress of the reindexing task in Elasticsearch. It appears in decimal form, from 0 to 1.

      • runningReindexCount number
GET /api/upgrade_assistant/reindex/batch/queue 
curl \
 --request GET 'https://localhost:5601/api/upgrade_assistant/reindex/batch/queue' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "queue": [ 
    {
      "indexName": "index1",
      "newIndexName": "reindexed-v8-index2",
      "status": 3,
      "lastCompletedStep": 0,
      "locked": null,
      "reindexTaskId": null,
      "reindexTaskPercComplete": null,
      "errorMessage": null,
      "runningReindexCount": null,
      "reindexOptions": {
        "queueSettings": {
          "queuedAt": 1583406985489
        }
      }
    },
    {
      "indexName": "index2",
      "newIndexName": "reindexed-v8-index2",
      "status": 3,
      "lastCompletedStep": 0,
      "locked": null,
      "reindexTaskId": null,
      "reindexTaskPercComplete": null,
      "errorMessage": null,
      "runningReindexCount": null,
      "reindexOptions": {
        "queueSettings": {
          "queuedAt": 1583406987334
        }
      }
    }
  ]
}