Query parameters

• actions array[string]

  The task action names, which are used to limit the response.

• detailed boolean

  If true, the response includes detailed information about shard recoveries.

  Default value is false.

• nodes array[string]

  Unique node identifiers, which are used to limit the response.

• parent_task_id string

  The parent task identifier, which is used to limit the response.

• h string | array[string]

  A comma-separated list of columns names to display. It supports simple wildcards.

  Supported values include:

  • id: The ID of the task with the node.
  • action (or ac): The task action.
  • task_id (or ti): The unique task ID.
  • parent_task_id (or pti): The parent task ID.
  • type (or ty): The task type.
  • start_time (or start): The start time in milliseconds.
  • timestamp (or ts, hms, hhmmss): The start time in HH:MM:SS.
  • running_time_ns (or time): The running time in nanoseconds.
  • running_time (or time): The running time.
  • node_id (or ni): The unique node ID.
  • ip (or i): The IP address.
  • port (or po): The bound transport port.
  • node (or n): The node name.
  • version (or v): The Elasticsearch version.
  • x_opaque_id (or x): The X-Opaque-ID header.

  Values are id, action, ac, task_id, ti, parent_task_id, pti, type, ty, start_time, start, timestamp, ts, hms, hhmmss, running_time_ns, time, running_time, node_id, ni, ip, i, port, po, node, n, version, v, x_opaque_id, or x.

• s string | array[string]

  List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

• timeout string

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

  Default value is 30s.

• wait_for_completion boolean

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

  Default value is false.

• format string

  Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

  Default value is text.

• help boolean

  When set to true will output available columns. This option can't be combined with any other query string option.

  Default value is false.

• v boolean

  When set to true will enable verbose output.

  Default value is false.

• bytes string

  Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

  Values are b, kb, mb, gb, tb, or pb.

• time string

  Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

  Values are nanos, micros, ms, s, m, h, or d.

Responses

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

  • id string

    The identifier of the task with the node.

  • action string

    The task action.

  • task_id string

    The unique task identifier.

  • parent_task_id string

    The parent task identifier.

  • type string

    The task type.

  • start_time string

    The start time in milliseconds.

  • timestamp string

    The start time in HH:MM:SS format.

  • running_time_ns string

    The running time in nanoseconds.

  • running_time string

    The running time.

  • node_id string

    The unique node identifier.

  • ip string

    The IP address for the node.

  • port string

    The bound transport port for the node.

  • node string

    The node name.

  • version string

    The Elasticsearch version.

  • x_opaque_id string

    The X-Opaque-ID header.

  • description string

    The task action description.