Documentation

InfluxDB Enterprise

Manage node labels

Assign user-defined labels to nodes in your InfluxDB Enterprise cluster. Node labels are user-defined key-value pairs assigned to nodes in your cluster that act as metadata for each node.

The tools used for viewing and managing node labels in your InfluxDB Enterprise cluster are the influxd-ctl show command and the influxd-ctl node-label command and subcommands.

View node labels

Use the influxd-ctl show command to view information about nodes in your InfluxDB Enterprise cluster, including node labels.

influxd-ctl show

View example influxd-ctl show output

Add labels to a node

To add a label to a node in your InfluxDB Enterprise cluster, use the influxd-ctl node-labels set command and include the following flags:

  • -nodeid: Node ID to add the labels to
  • -labels: JSON object of label key-value pairs
influxd-ctl node-labels set -nodeid 4 -labels '{"az":"us-east","team":"amer"}'

View influxd-ctl show output with added labels

Update node labels

To update node labels, use the influxd-ctl node-labels set command and include the following flags:

  • -nodeid: Node ID to update the labels on
  • -labels: JSON object of label key-value pairs to update
influxd-ctl node-labels set -nodeid 4 -labels '{"team":"emea"}'

Only label keys included in the -labels JSON object are updated. All other node labels are not modified.

View influxd-ctl show output with updated labels

Delete node labels

To update node labels, use the influxd-ctl node-labels set command and include the following flags:

  • -nodeid: Node ID to update the labels on
  • -labels: JSON object of label key-value pairs to update
influxd-ctl node-labels delete -nodeid 4 -labels '["team"]'

View influxd-ctl show output with deleted label

Programmatically access node labels

Use the /show-cluster endpoint of meta node API to return a JSON object containing information about your InfluxDB Enterprise cluster, including node labels.

GET meta-node-host:8191/show-cluster

View example JSON output

Was this page helpful?

Thank you for your feedback!

© 2024 InfluxData, Inc.

Where are you running InfluxDB?

Customize your InfluxDB Enterprise URL and we’ll update code examples for you.

Default
Custom

For more information, see InfluxDB Enterprise HTTP settings.

Thank you for your feedback!

Let us know what we can do better:

Thank you!

No thanks

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.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: