docs-v2/content/influxdb3/cloud-dedicated/admin/databases/list.md

8.7 KiB

title description menu weight list_code_example related
List databases Use the Admin UI, the [`influxctl database list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/), or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to list databases in your InfluxDB Cloud Dedicated cluster.
influxdb3_cloud_dedicated
parent
Manage databases
202 ##### CLI ```sh influxctl database list ``` ##### API ```sh curl \ --location "https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" \ --header "Accept: application/json" \ --header "Authorization: Bearer MANAGEMENT_TOKEN" ```
/influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/
/influxdb3/cloud-dedicated/reference/api/

Use the Admin UI, the influxctl database list command, or the Management HTTP API to list databases in your {{< product-name omit=" Clustered" >}} cluster.

{{< tabs-wrapper >}} {{% tabs %}} Admin UI influxctl Management API {{% /tabs %}} {{% tab-content %}}

Access the Cloud Dedicated Admin UI

  1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser:

    https://console.influxdata.com
    
  2. Use the credentials provided by InfluxData to log into the Admin UI. If you don't have login credentials, contact InfluxData support.

    After you log in, the Account Management portal displays account information and lists all clusters associated with your account.

  3. You can Search for clusters by name or ID to filter the list and use the sort button and column headers to sort the list.

  4. Click the cluster row to view the list of databases associated with the cluster.

The database list displays the following database details:

  • Name
  • Database ID
  • Max tables
  • Max columns per table
  • Retention period

You can Search for databases by name or ID to filter the list and use the sort button and column headers to sort the list.

{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-list-databases.png" alt="List databases" />}}

Database management tools

The options button (3 vertical dots) to the right of any database provides additional tools:

  • Copy Database ID: Copy the database ID to your clipboard
  • Set Retention Period: Set the retention period for the database
  • Delete Database: Delete the database

Manage database tables

To view database details and manage database tables, click the database row in the list. {{% /tab-content %}} {{% tab-content %}}

Use the influxctl database list command to list databases in your InfluxDB Cloud Dedicated cluster.

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

  2. In your terminal, run the influxctl database list command and provide the following:

influxctl database list --format table

{{% /tab-content %}} {{% tab-content %}}

This example uses cURL to send a Management HTTP API request, but you can use any HTTP client.

  1. If you haven't already, follow the instructions to install cURL for your system.

  2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint:

    {{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" method="get" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/GetClusterDatabases" %}}

    In the URL, provide the following credentials:

    Provide the following request headers:

The following example shows how to use the Management API to list databases in a cluster:

{{% code-placeholders "ACCOUNT_ID|CLUSTER_ID|MANAGEMENT_TOKEN" %}}

curl \
   --location "https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases" \
   --header "Accept: application/json" \
   --header "Authorization: Bearer MANAGEMENT_TOKEN"

{{% /code-placeholders %}}

Replace the following in your request:

  • {{% code-placeholder-key %}}ACCOUNT_ID{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} account to create the database for
  • {{% code-placeholder-key %}}CLUSTER_ID{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} cluster to create the database for
  • {{% code-placeholder-key %}}MANAGEMENT TOKEN{{% /code-placeholder-key %}}: a management token for your {{% product-name %}} cluster

{{% /tab-content %}} {{< /tabs-wrapper >}}

Output format

The influxctl database list command supports two output formats: table and json. By default, the command outputs the list of databases formatted as a table. For easier programmatic access to the command output, include --format json with your command to format the output as JSON.

The Management API outputs JSON format in the response body.

Retention period syntax

In table format, a retention period is a time duration value made up of a numeric value plus a duration unit--for example, 30d means 30 days. An infinite retention period means data won't expire.

In JSON format, a retention period value is an integer (<int32>) that represents the number of nanoseconds--for example, 2592000000000 means 30 days. A zero (0) retention period means data won't expire.

Example output

{{< code-tabs-wrapper >}} {{% code-tabs %}} table JSON {{% /code-tabs %}} {{% code-tab-content %}}

+---------------+------------------+------------+-----------------------+
| DATABASE NAME | RETENTION PERIOD | MAX TABLES | MAX COLUMNS PER TABLE |
+---------------+------------------+------------+-----------------------+
| mydb1         | infinite         |        500 |                   250 |
| mydb2         | infinite         |        500 |                   200 |
| mydb3         | 24h              |        100 |                   200 |
+---------------+------------------+------------+-----------------------+

{{% /code-tab-content %}} {{% code-tab-content %}}

[
  {
    "account_id": "0x0x0x00-0Xx0-00x0-x0X0-00x00XX0Xx0X",
    "cluster_id": "X0x0xxx0-0XXx-000x-00x0-0X000Xx00000",
    "database_name": "mydb1",
    "retention_period_ns": 0,
    "max_tables": 500,
    "max_columns_per_table": 250
  },
  {
    "account_id": "0x0x0x00-0Xx0-00x0-x0X0-00x00XX0Xx0X",
    "cluster_id": "X0x0xxx0-0XXx-000x-00x0-0X000Xx00000",
    "database_name": "mydb2",
    "retention_period_ns": 0,
    "max_tables": 500,
    "max_columns_per_table": 200
  },
  {
    "account_id": "0x0x0x00-0Xx0-00x0-x0X0-00x00XX0Xx0X",
    "cluster_id": "X0x0xxx0-0XXx-000x-00x0-0X000Xx00000",
    "database_name": "mydb3",
    "retention_period_ns": 86400000000000,
    "max_tables": 100,
    "max_columns_per_table": 200
  },
]

{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}