Path parameters

• thread_pool_patterns string | array[string] Required

  A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.

Query parameters

• h string | array[string]

  List of columns to appear in the response. Supports simple wildcards.

  Supported values include:

  • active (or a): Number of active threads in the current thread pool.
  • completed (or c): Number of tasks completed by the thread pool executor.
  • core (or cr): Configured core number of active threads allowed in the current thread pool.
  • ephemeral_id (or eid): Ephemeral node ID.
  • host (or h): Hostname for the current node.
  • ip (or i): IP address for the current node.
  • keep_alive (or k): Configured keep alive time for threads.
  • largest (or l): Highest number of active threads in the current thread pool.
  • max (or mx): Configured maximum number of active threads allowed in the current thread pool.
  • name: Name of the thread pool, such as analyze or generic.
  • node_id (or id): ID of the node, such as k0zy.
  • node_name: Node name, such as I8hydUG.
  • pid (or p): Process ID of the running node.
  • pool_size (or psz): Number of threads in the current thread pool.
  • port (or po): Bound transport port for the current node.
  • queue (or q): Number of tasks in the queue for the current thread pool.
  • queue_size (or qs): Maximum number of tasks permitted in the queue for the current thread pool.
  • rejected (or r): Number of tasks rejected by the thread pool executor.
  • size (or sz): Configured fixed number of active threads allowed in the current thread pool.
  • type (or t): Type of thread pool. Returned values are fixed, fixed_auto_queue_size, direct, or scaling.

  Values are active, a, completed, c, core, cr, ephemeral_id, eid, host, h, ip, i, keep_alive, k, largest, l, max, mx, name, node_id, id, node_name, pid, p, pool_size, psz, port, po, queue, q, queue_size, qs, rejected, r, size, sz, type, or t.

• s string | array[string]

  A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

• local boolean

  If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

• master_timeout string

  The period to wait for a connection to the master node.

  External documentation

Responses

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

  • node_name string

    The node name.

  • node_id string

    The persistent node identifier.

  • ephemeral_node_id string

    The ephemeral node identifier.

  • pid string

    The process identifier.

  • host string

    The host name for the current node.

  • ip string

    The IP address for the current node.

  • port string

    The bound transport port for the current node.

  • name string

    The thread pool name.

  • type string

    The thread pool type. Returned values include fixed, fixed_auto_queue_size, direct, and scaling.

  • active string

    The number of active threads in the current thread pool.

  • pool_size string

    The number of threads in the current thread pool.

  • queue string

    The number of tasks currently in queue.

  • queue_size string

    The maximum number of tasks permitted in the queue.

  • rejected string

    The number of rejected tasks.

  • largest string

    The highest number of active threads in the current thread pool.

  • completed string

    The number of completed tasks.

  • core string | null

    The core number of active threads allowed in a scaling thread pool.

    One of:

    string-1 string string-2 string | null

  • max string | null

    The maximum number of active threads allowed in a scaling thread pool.

    One of:

    string-1 string string-2 string | null

  • size string | null

    The number of active threads allowed in a fixed thread pool.

    One of:

    string-1 string string-2 string | null

  • keep_alive string | null

    The thread keep alive time.

    One of:

    string-1 string string-2 string | null