Get task information | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Query parameters

• The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
• If true, the request blocks until the task has completed.

Responses

• 200 application/json
  Hide response attributes Show response attributes object
  • task
    object Required Additional properties
    Hide task attributes Show task attributes object
    * 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.
    * Hide headers attribute Show headers attribute object
    * *
    string Additional properties
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Time unit for nanoseconds
    * Time unit for milliseconds
    * 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.
  • Hide error attributes Show error attributes object
    * The type of error
    * A human-readable explanation of the error, in English.
    * The server stack trace. Present only if the error_trace=true parameter was sent with the request.