Query parameters

• detailed boolean

  If true, include detailed task status information in the response.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • reindex array[object] Required

    The list of currently running reindex tasks.

    Hide reindex attributes Show reindex attributes object

    Information about a single parent reindex task, as returned by the reindex management APIs.

    • id string Required

      The ID of the reindex task. The ID is assigned when the task was first created and remains the same across graceful shutdown relocations.

    • description string

      A sanitized description of the reindex operation (source and destination indices, and optionally remote host info).

    • start_time_in_millis number

      Time unit for milliseconds

    • start_time string

      The time at which the reindex task started, as an ISO-8601 formatted string. Remains the same across graceful shutdown relocations. Only present when the request includes the ?human=true query parameter.

    • running_time string

      The elapsed running time of the reindex task, including relocations, in a human-readable format. Only present when the request includes the ?human=true query parameter.

      External documentation
    • running_time_in_nanos number

      Time unit for nanoseconds

    • cancelled boolean Required

      Whether the reindex task has been cancelled.

    • status object

      The current progress of the reindex operation.

      Hide status attributes Show status attributes object

      • slice_id number

        The slice ID

      • batches number Required

        The number of scroll responses pulled back by the reindex.

      • created number

        The number of documents that were successfully created.

      • deleted number Required

        The number of documents that were successfully deleted.

      • noops number Required

        The number of documents that were ignored because the script used for the reindex returned a noop value for ctx.op.

      • requests_per_second number Required

        The number of requests per second effectively executed during the reindex.

      • retries object Required

        The number of retries attempted by reindex. bulk is the number of bulk actions retried and search is the number of search actions retried.

      • throttled string

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • throttled_until string

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • total number Required

        The number of documents that were successfully processed.

      • updated number

        The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.

      • version_conflicts number Required

        The number of version conflicts that reindex hits.

      • cancelled string

        The reason for cancellation if the slice was canceled

  • task_failures array[object]

    Per-task failures encountered while listing reindex tasks. Tasks that failed are not included in the reindex array.

    Hide task_failures attributes Show task_failures attributes object

    • task_id number Required
    • node_id string Required
    • status string Required
    • reason object Required

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Hide reason attributes Show reason attributes object

      • type string Required

        The type of error

      • reason string | null

        A human-readable explanation of the error, in English.

        One of:

        string-1 string string-2 string | null
      • stack_trace string

        The server stack trace. Present only if the error_trace=true parameter was sent with the request.

      • caused_by object

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • root_cause array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • suppressed array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

  • node_failures array[object]

    Node-level failures encountered while listing reindex tasks. Typically populated when a node disconnects or stops responding mid-request, reindex tasks running on such nodes will be missing from the reindex array for the duration of the disruption.

    Hide node_failures attributes Show node_failures attributes object

    Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • type string Required

      The type of error

    • reason string | null

      A human-readable explanation of the error, in English.

      One of:

      string-1 string string-2 string | null
    • stack_trace string

      The server stack trace. Present only if the error_trace=true parameter was sent with the request.

    • caused_by object

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • root_cause array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • suppressed array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.