Get the reindex status Technical Preview

GET /api/upgrade_assistant/reindex/{index}
Api key auth Basic auth

Check the status of the reindex task.

Path parameters

  • index string Required

    The name of the index that is reindexing.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • hasRequiredPrivileges boolean

      Specifies whether the user has sufficient privileges to reindex this index. When security is unavailable or disabled, it is true.

    • reindexOp object
      Hide reindexOp attributes Show reindexOp 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.
      • newIndexName string

        The name of the new index.

      • 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.

      • status integer

        The reindex status. For example:

        • 0: In progress - 1: Completed - 2: Failed - 3: Paused
    • warnings array

      An array of any warning codes that explain what changes are required for this reindex. For example:

      • 0 specifies to remove the _all meta field. - 1 specifies to convert any coerced boolean values in the source document. For example, yes, 1, and off. - 2 specifies to convert documents to support Elastic Common Schema. Applies only to APM indices created in 6.x.
GET /api/upgrade_assistant/reindex/{index} 
curl \
 --request GET 'http://localhost:5622/api/upgrade_assistant/reindex/{index}' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "reindexOp": {
    "indexName": ".ml-state",
    "newIndexName": ".reindexed-v7-ml-state", 
    "status": 0, 
    "lastCompletedStep": 40, 
    "reindexTaskId": "QprwvTMzRQ2MLWOW22oQ4Q:11819", 
    "reindexTaskPercComplete": 0.3, 
    "errorMessage": null 
  },
  "warnings": [], 
  "hasRequiredPrivileges": true 
}