Query parameters

• actions string | array[string]

  Comma-separated list or wildcard expression of actions used to limit the request.

• nodes array[string]

  Comma-separated list of node IDs or names used to limit the request.

• parent_task_id string

  Parent task ID used to limit the tasks.

• wait_for_completion boolean

  Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false

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

            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.

          • 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

            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.

            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

      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.

    • 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

      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.

      Additional properties are allowed.

    • type string Required

    • parent_task_id string | number

      One of:

      _types:TaskId string _types:TaskId number