Batch start or resume reindexing Technical Preview

POST /api/upgrade_assistant/reindex/batch
Api key auth Basic auth

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.

application/json

Body Required

  • indexNames array[string] Required

    The list of index names to be reindexed. The order of the indices determines the order that the reindex tasks are run.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • enqueued array[object]

      A list of reindex tasks created. The order in the array indicates the order in which tasks will be run.

      Hide enqueued attributes Show enqueued 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
    • errors array

      A list of errors that may have occurred preventing the reindex task from being created.
POST /api/upgrade_assistant/reindex/batch 
curl \
 --request POST 'https://localhost:5601/api/upgrade_assistant/reindex/batch' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"indexNames":["string"]}'
Request examples 
{
  "indexNames": [
    "string"
  ]
}
Response examples (200) 
{
  "enqueued": [ 
    {
      "indexName": "index1",
      "newIndexName": "reindexed-v8-index1",
      "status": 3,
      "lastCompletedStep": 0,
      "locked": null,
      "reindexTaskId": null,
      "reindexTaskPercComplete": null,
      "errorMessage": null,
      "runningReindexCount": null,
      "reindexOptions": { 
        "queueSettings": {
          "queuedAt": 1583406985489 
        }
      }
    }
  ],
  "errors": [ 
    {
      "indexName": "index2",
      "message": "Something went wrong!"
    }
  ]
}