Path parameters

• task_id string Required

  ID of the task.

Query parameters

• timeout string

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

• wait_for_completion boolean

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

Responses

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

  • completed boolean Required
  • task object Required
    Hide task attributes Show task attributes object

    • action string Required
    • cancelled boolean
    • cancellable boolean Required
    • description string
    • headers object Required
      Hide headers attributes Show headers attributes object

      • Additional properties
      • key string
    • id number Required
    • node string Required
    • running_time 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.

    • running_time_in_nanos number

      Time unit for nanoseconds

    • start_time_in_millis number

      Time unit for milliseconds

    • status object

      Task status information can vary wildly from task to task.

    • type string Required

    • parent_task_id string | number

      One of:

      _types:TaskId string _types:TaskId number
  • response object
  • error object
    Hide error attributes Show error attributes object

    • type string Required

      The type of error

    • reason string

      A human-readable explanation of the error, in english

    • stack_trace string

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

    • caused_by object
    • root_cause array[object]
    • suppressed array[object]