Path parameters

• task_idstring Required

  The task identifier.

Query parameters

• timeoutstring

  The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  Values are -1 or 0.

• wait_for_completionboolean

  If true, the request blocks until the task has completed.

Responses

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

  • completedboolean Required
  • taskobject Required Additional properties
    Hide task attributes Show task attributes object

    • actionstring Required
    • cancelledboolean
    • cancellableboolean Required
    • descriptionstring

      Human readable text that identifies the particular request that the task is performing. For example, it might identify the search request being performed by a search task. Other kinds of tasks have different descriptions, like _reindex which has the source and the destination, or _bulk which just has the number of requests and the destination indices. Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request.

    • headersobject Required
      Hide headers attribute Show headers attribute object
    • idnumber Required
    • nodestring Required
    • running_timestring

      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.

    • running_time_in_nanosnumber

      Time unit for nanoseconds

    • start_time_in_millisnumber

      Time unit for milliseconds

    • statusobject

      The internal status of the task, which varies from task to task. The format also varies. While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.

    • typestring Required
    • parent_task_idstring
  • responseobject
  • errorobject

    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 error attributes Show error attributes object

    • typestring Required

      The type of error

    • reasonstring | null

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

      One of:

      string-1stringstring-2string | null
    • stack_tracestring

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

    • caused_byobject

      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_causearray[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.

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