Path parameters

• node_id string | array[string]

  A comma-separated list of node identifiers or names used to limit the returned information.

Query parameters

• h string | array[string]

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

  Supported values include:

  • shards (or s): The number of shards on the node.
  • shards.undesired: The number of shards scheduled to be moved elsewhere in the cluster.
  • write_load.forecast (or wlf, writeLoadForecast): The sum of index write load forecasts.
  • disk.indices.forecast (or dif, diskIndicesForecast): The sum of shard size forecasts.
  • disk.indices (or di, diskIndices): The disk space used by Elasticsearch indices.
  • disk.used (or du, diskUsed): The total disk space used on the node.
  • disk.avail (or da, diskAvail): The available disk space on the node.
  • disk.total (or dt, diskTotal): The total disk capacity of all volumes on the node.
  • disk.percent (or dp, diskPercent): The percentage of disk space used on the node.
  • host (or h): IThe host of the node.
  • ip: The IP address of the node.
  • node (or n): The name of the node.
  • node.role (or r, role, nodeRole): The roles assigned to the node.

  Values are shards, s, shards.undesired, write_load.forecast, wlf, writeLoadForecast, disk.indices.forecast, dif, diskIndicesForecast, disk.indices, di, diskIndices, disk.used, du, diskUsed, disk.avail, da, diskAvail, disk.total, dt, diskTotal, disk.percent, dp, diskPercent, host, h, ip, node, n, node.role, r, role, or nodeRole.

• 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.

• 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

  Period to wait for a connection to the master node.

  External documentation

Responses

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

  • shards string

    Number of primary and replica shards assigned to the node.

  • shards.undesired string | null

    Amount of shards that are scheduled to be moved elsewhere in the cluster or -1 other than desired balance allocator is used

    One of:

    string-1 string string-2 string | null

  • write_load.forecast number | string | null

    Sum of index write load forecasts

    One of:

    number-1 number string-2 string string-2 string | null

  • disk.indices.forecast number | string | null

    Sum of shard size forecasts

    One of:

    number-1 number string-2 string string-2 string | null

  • disk.indices number | string | null

    Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index.

    One of:

    number-1 number string-2 string string-2 string | null

  • disk.used number | string | null

    Total disk space in use. Elasticsearch retrieves this metric from the node’s operating system (OS). The metric includes disk space for: Elasticsearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. Unlike disk.indices, this metric does not double-count disk space for hard-linked files.

    One of:

    number-1 number string-2 string string-2 string | null

  • disk.avail number | string | null

    Free disk space available to Elasticsearch. Elasticsearch retrieves this metric from the node’s operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space.

    One of:

    number-1 number string-2 string string-2 string | null

  • disk.total number | string | null

    Total disk space for the node, including in-use and available space.

    One of:

    number-1 number string-2 string string-2 string | null

  • disk.percent string | number | null

    Total percentage of disk space in use. Calculated as disk.used / disk.total.

    One of:

    string-1 string number-2 number string-2 string | null

  • host string | null

    Network host for the node. Set using the network.host setting.

    One of:

    Host string string-2 string | null

  • ip string | null

    IP address and port for the node.

    One of:

    Ip string string-2 string | null
  • node string

    Name for the node. Set using the node.name setting.

  • node.role string | null

    Node roles

    One of:

    string-1 string string-2 string | null