influx v1 dbrp list
The influx v1 dbrp list
command lists and searches DBRP mappings in the InfluxDB 1.x compatibility API.
Usage
influx v1 dbrp list [flags]
Flags
Flag | Description | Input type | Maps to ? | |
---|---|---|---|---|
-c |
--active-config |
Config name to use for command | string | INFLUX_ACTIVE_CONFIG |
--bucket-id |
Bucket ID | |||
--configs-path |
Path to the influx CLI configurations (default: ~/.influxdbv2/configs ) |
string | INFLUX_CONFIGS_PATH |
|
--db |
Filter DBRP mappings by database | |||
--default |
Limit results to default mapping | |||
-h |
--help |
Help for the list command |
||
--hide-headers |
Hide the table headers (default: false ) |
INFLUX_HIDE_HEADERS |
||
--host |
HTTP address of InfluxDB | string | INFLUX_HOST |
|
--id |
Limit results to a specified mapping | string | ||
--json |
Output data as JSON (default: false ) |
INFLUX_OUTPUT_JSON |
||
-o |
--org |
Organization name (mutually exclusive with --org-id ) |
string | INFLUX_ORG |
--org-id |
Organization ID (mutually exclusive with --org ) |
string | INFLUX_ORG_ID |
|
--rp |
Filter DBRP mappings by InfluxDB v1 retention policy | string | INFLUX_ORG |
|
--skip-verify |
Skip TLS certificate verification | INFLUX_SKIP_VERIFY |
||
-t |
--token |
API token | string | INFLUX_TOKEN |
Examples
Authentication credentials
The examples below assume your InfluxDB host, organization, and token are
provided by either the active influx
CLI configuration or by environment variables (INFLUX_HOST
, INFLUX_ORG
, and INFLUX_TOKEN
).
If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:
--host
: InfluxDB host-o, --org
or--org-id
: InfluxDB organization name or ID-t, --token
: InfluxDB API token
List all DBRP mappings in your organization
influx v1 dbrp list
List DBRP mappings for specific buckets
influx v1 dbrp list \
--bucket-id 12ab34cd56ef78 \
--bucket-id 09zy87xw65vu43
List DBRP mappings with a specific database
influx v1 dbrp list --db example-db
List DBRP mappings with a specific retention policy
influx v1 dbrp list --rp example-rp
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.