Documentation

List clusters

Use the influxctl cluster list CLI command view information about all InfluxDB Cloud Dedicated clusters associated with your account ID.

  1. If you haven’t already, download and install the influxctl CLI, and then configure a connection profile for your cluster.

  2. Run influxctl cluster list with the following:

    influxctl cluster list --format table
    

Output formats

The influxctl cluster list command supports two output formats: table and json. By default, the output is formatted as a table.

Example table

+--------------------------------------+------------------+-------+----------------------------------------------------+
| ID                                   | NAME             | STATE | URL                                                |
+--------------------------------------+------------------+-------+----------------------------------------------------+
| X0x0xxx0-0XXx-000x-00x0-0X000Xx00000 | Internal - Cluster 1 | ready | X0x0xxx0-0XXx-000x-00x0-0X000Xx00000.a.influxdb.io |
+--------------------------------------+------------------+-------+----------------------------------------------------+

Detailed output in JSON

For additional cluster details and easier programmatic access to the command output, include --format json with your command–for example:

influxctl cluster list --format json

The output is a JSON array of cluster objects that include additional fields such as account ID and created date.

[
  {
    "account_id": "0x0x0x00-0Xx0-00x0-x0X0-00x00XX0Xx0X",
    "cluster_id": "X0x0xxx0-0XXx-000x-00x0-0X000Xx00000",
    "name": "Internal - Cluster 1",
    "url": "X0x0xxx0-0XXx-000x-00x0-0X000Xx00000.a.influxdb.io",
    "state": "ready",
    "created_at": {
      "seconds": 1686670941,
      "nanos": 520023000
    },
    "category": 1
  }
]

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more