TiDBTiDB Docs Dash 2024

Jan 9 - Jan 12 (UTC)
Join us to improve docs and win a prize!
Sign InTry Free

Configure an IP Access List

For each TiDB Dedicated cluster in TiDB Cloud, you can configure an IP access list to filter internet traffic trying to access the cluster, which works similarly to a firewall access control list. After the configuration, only the clients and applications whose IP addresses are in the IP access list can connect to your TiDB Dedicated cluster.

For a TiDB Dedicated cluster, you can configure its IP access list in either of the following ways:

Configure an IP access list in standard connection

To configure an IP access list for your TiDB Dedicated cluster in standard connection, take the following steps:

  1. In the TiDB Cloud console, navigate to the Clusters page of your project.

  2. In the row of your TiDB Dedicated cluster, click ... and select Connect. A dialog is displayed.

  3. In the dialog, locate Step 1: Create traffic filter on the Standard Connection tab and configure the IP access list.

    • If the IP access list of your cluster has not been set, you can click Add My Current IP Address to add your current IP address to the IP access list, and then click Add Item to add more IP addresses if necessary. Next, click Update Filter to save the configuration.

    • If the IP access list of your cluster has been set, click Edit to add, edit, or remove IP addresses, and then click Update Filter to save the configuration.

    • To allow any IP address to access your cluster (not recommended), click Allow Access From Anywhere, and then click Update Filter. According to security best practices, it is NOT recommended that you allow any IP address to access your cluster, as this would expose your cluster to the internet completely, which is highly risky.

Configure an IP access list in security settings

To configure an IP access list for your TiDB Dedicated cluster in security settings, take the following steps:

  1. In the TiDB Cloud console, navigate to the Clusters page of your project.

  2. In the row of your TiDB Dedicated cluster, click ... and select Security Settings. A security setting dialog is displayed.

  3. In the dialog, configure the IP access list as follows:

    • To add your current IP address to the IP access list, click Add My Current IP Address.

    • To add an IP address to the IP access list, enter the IP address and description, and click Add to IP List.

    • To allow any IP address to access your cluster (not recommended), click Allow Access From Anywhere. According to security best practices, it is NOT recommended that you allow any IP address to access your cluster, as this would expose your cluster to the internet completely, which is highly risky.

    • To remove an IP address from the access list, click Remove in the line of the IP address.

  4. Click Apply to save the configuration.

Was this page helpful?

Download PDFRequest docs changesAsk questions on Discord
Playground
New
One-stop & interactive experience of TiDB's capabilities WITHOUT registration.
Products
TiDB
TiDB Dedicated
TiDB Serverless
Pricing
Get Demo
Get Started
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.