docs-v2

4.3 KiB

Raw Blame History

The influxdb3 show nodes command displays information about nodes in your {{< product-name >}} cluster, including their state, mode, and resource usage.

Usage

influxdb3 show nodes [OPTIONS]

Options

Option		Description
`-H`	`--host`	Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`)
	`--format`	Output format: `pretty` (default), `json`, or `csv`
	`--token`	Authentication token
	`--tls-ca`	Path to a custom TLS certificate authority (for testing or self-signed certificates)
`-h`	`--help`	Print help information

Option environment variables

You can use the following environment variables to set command options:

Environment Variable	Option
`INFLUXDB3_HOST_URL`	`--host`
`INFLUXDB3_AUTH_TOKEN`	`--token`

Output

The command displays the following information for each node:

node_id: The unique identifier for the node
node_catalog_id: The internal catalog identifier
instance_id: The unique instance identifier
mode: The node's operating modes (ingest, query, process, compact)
core_count: Number of CPU cores allocated to the node
state: Current node state (running or stopped)
updated_at: Timestamp of the last update
cli_params: Command-line parameters used to start the node

List all nodes in pretty format

influxdb3 show nodes

+----------+-----------------+--------------------------------------+--------+------------+---------+---------------------------+
| node_id  | node_catalog_id | instance_id                          | mode   | core_count | state   | updated_at                |
+----------+-----------------+--------------------------------------+--------+------------+---------+---------------------------+
| node-1   | 0               | e38944e4-1204-4bb4-92f3-71138894d674 | ingest | 1          | running | 2025-09-04T10:15:57.126   |
| node-2   | 1               | f5418c97-eb6d-47b5-8176-efc0ad7b882e | ingest | 1          | stopped | 2025-09-04T10:16:57.503   |
+----------+-----------------+--------------------------------------+--------+------------+---------+---------------------------+

List nodes in JSON format

influxdb3 show nodes --format json

The output is similar to the following:

[
  {
    "node_id": "node-1",
    "node_catalog_id": 0,
    "instance_id": "e38944e4-1204-4bb4-92f3-71138894d674",
    "mode": [
      "ingest"
    ],
    "core_count": 1,
    "state": "running",
    "updated_at": "2025-09-04T10:15:57.126",
    "cli_params": "{\"http-bind\":\"127.0.0.1:8181\",\"node-id\":\"node-1\",\"data-dir\":\"/path/to/data\",\"object-store\":\"file\",\"mode\":\"ingest\"}"
  },
  {
    "node_id": "node-2",
    "node_catalog_id": 1,
    "instance_id": "f5418c97-eb6d-47b5-8176-efc0ad7b882e",
    "mode": [
      "ingest"
    ],
    "core_count": 1,
    "state": "stopped",
    "updated_at": "2025-09-04T10:16:57.503",
    "cli_params": "{\"http-bind\":\"127.0.0.1:8182\",\"node-id\":\"node-2\",\"data-dir\":\"/path/to/data\",\"object-store\":\"file\",\"mode\":\"ingest\"}"
  }
]

List nodes on a remote server

influxdb3 show nodes \
  --host INFLUXDB_HOST \
  --token AUTH_TOKEN

Replace the following:

{{% code-placeholder-key %}}AUTH_TOKEN{{% /code-placeholder-key %}}: Authentication token with sufficient privileges
{{% code-placeholder-key %}}INFLUXDB_HOST{{% /code-placeholder-key %}}: Host URL of the running {{< product-name >}} server

4.3 KiB Raw Blame History