Path parameters

• task_id string | number Required

  The ID for the task.

Query parameters

• requests_per_second number

  The throttle for this request in sub-requests per second.

Responses

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

  • node_failures array[object]
    Hide node_failures attributes Show node_failures 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

      Additional properties are allowed.

    • root_cause array[object]

      Additional properties are allowed.

    • suppressed array[object]

      Additional properties are allowed.

  • task_failures array[object]
    Hide task_failures attributes Show task_failures attributes object

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

      Additional properties are allowed.

      Hide reason attributes Show reason 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

        Additional properties are allowed.

      • root_cause array[object]

        Additional properties are allowed.

      • suppressed array[object]

        Additional properties are allowed.

  • nodes object

    Task information grouped by node, if group_by was set to node (the default).

    Hide nodes attribute Show nodes attribute object

    • * object Additional properties

      Additional properties are allowed.

      Hide * attributes Show * attributes object

      • name string
      • transport_address string
      • host string
      • ip string
      • roles array[string]
      • attributes object
        Hide attributes attribute Show attributes attribute object

        • * string Additional properties
      • tasks object Required
        Hide tasks attribute Show tasks attribute object

        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object

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

            • * string Additional properties
          • 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.

            Additional properties are allowed.

          • type string Required

          • parent_task_id string | number

            One of:

            _types:TaskId string _types:TaskId number

  • tasks array[object] | object

    One of:

    _types:TaskInfos array[object] _types:TaskInfos object

    Hide attributes Show attributes object

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

      • * string Additional properties
    • 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.

      Additional properties are allowed.

    • type string Required

    • parent_task_id string | number

      One of:

      _types:TaskId string _types:TaskId number