Path parameters

• node_id string | array[string] Required

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

Query parameters

• bytes string

  The unit used to display byte values.

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

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:

    _spec_utils:Stringifieddouble number _spec_utils:Stringifieddouble string string-2 string | null

  • disk.indices.forecast number | string | null

    Sum of shard size forecasts

    One of:

    _types:ByteSize number _types:ByteSize 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:

    _types:ByteSize number _types:ByteSize 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:

    _types:ByteSize number _types:ByteSize 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:

    _types:ByteSize number _types:ByteSize string string-2 string | null

  • disk.total number | string | null

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

    One of:

    _types:ByteSize number _types:ByteSize 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:

    _types:Percentage string _types:Percentage number string-2 string | null

  • host string | null

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

    One of:

    _types:Host string string-2 string | null

  • ip string | null

    IP address and port for the node.

    One of:

    _types: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