DocsICP FilingConsole
Documentation
Home Page ApsaraDB RDS RDS MySQL Database User Guide Database connection Connect to an ApsaraDB RDS for MySQL instance Connect to an RDS MySQL instance by CLI or client

Connect to an RDS MySQL instance by CLI or client

Updated at:
Copy as MD
Product
My Favorites

After you create and configure an ApsaraDB for RDS for MySQL instance, you can connect to it. This topic describes how to connect to the instance over an internal network or the internet by using the command-line interface (CLI) or a client, and provides solutions to common connection errors.

Prerequisites

Recommendations

  • For lower latency and higher stability, connect to your RDS instance from an ECS instance over an internal network. The following conditions must be met for an internal network connection:

    The ECS instance and the RDS instance must be in the same Alibaba Cloud account, region, and Virtual Private Cloud (VPC). The private IP address of the ECS instance must be added to the IP address whitelist of the RDS instance.

    Note

    You can view the private IP address of your ECS instance on the Instances page.

    In the IP Address column of the instance list, a public IP address is marked with "(Public)", and a private IP address is marked with "(Private)".

  • For a public network connection, connect to the database by using its endpoint.

    Note

    • Query the public IP address of the local client by running curl ipinfo.io/ip (recommended) or curl ifconfig.me.

    • The public IP address of the RDS instance may change during a database upgrade or migration. If you have added your local IP address to the whitelist but still cannot connect, see the provided solution.

Procedure

Connect with the CLI

This example shows how to connect to an ApsaraDB for RDS for MySQL instance on a Linux system. First, install MySQL:

  • On CentOS, run sudo yum install mysql.

  • On Ubuntu, run sudo apt-get update, and then run sudo apt install mysql-server.

  1. Log on to the server that you will use to connect to the RDS instance, such as an ECS instance or a local server.

    Note

    For instructions on how to log on to an ECS instance, see the Connect to an ECS instance section in ECS Quick Start.

  2. Run the following command to connect:

    mysql -h<endpoint> -P<port> -u<username> -p
    Note

    • Enter the password after you run the command.

    • The uppercase letter P specifies the port, and the lowercase letter p specifies the password prompt.

    • Endpoint and port: The endpoint and port of the RDS instance.

      Scenario

      Required endpoint

      How to obtain

      You meet the conditions for an internal network connection.

      Internal endpoint

      1. Log on to the ApsaraDB RDS console and go to the Instances page. In the top navigation bar, select the region in which the RDS instance resides. Then, find the RDS instance and click the instance ID.

      2. Click View Details to view the RDS instance address and port number. In the Basic Information section, next to Network Type, click View Connection Details.

      Note

      • The public endpoint is displayed only after you click Apply for Public Endpoint.

      • For an RDS Cluster Edition instance, you can modify the primary node endpoint in the Cluster Read/Write Connection section and the secondary node endpoint in the Cluster Read-only Connection section.

      You are connecting from an ECS instance, but do not meet the conditions for an internal network connection.

      Public endpoint

      You are connecting from a local device.

    • Username and password: Obtain them from the Accounts page of the RDS instance.

    Command example

    root@xxx            -> mysql -hrxxx.mysql.rds.aliyuncs.com -P3306 -uxxx -p
Enter password:

    Successful connection

    Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 51325
Server version: 8.0.18 Source distribution
    Note

    If a connection error occurs, see Common connection errors.

Connect with MySQL Workbench

You can use other general-purpose MySQL clients to connect to an ApsaraDB for RDS for MySQL instance. This section uses MySQL Workbench 8.0.29 as an example. The procedure is similar for other clients.

  1. Install MySQL Workbench.

  2. Open MySQL Workbench and choose Database > Connect to Database.

  3. Enter the connection information and click OK.

    From the Connection Method drop-down list, select Standard (TCP/IP).

    • Hostname and Port: The endpoint and port of the RDS instance.

      Scenario

      Required endpoint

      How to obtain

      You meet the conditions for an internal network connection.

      Internal endpoint

      1. Log on to the ApsaraDB RDS console and go to the Instances page. In the top navigation bar, select the region in which the RDS instance resides. Then, find the RDS instance and click the instance ID.

      2. Click View Details to view the RDS instance address and port number. In the Basic Information section, next to Network Type, click View Connection Details.

      Note

      • The public endpoint is displayed only after you click Apply for Public Endpoint.

      • For an RDS Cluster Edition instance, you can modify the primary node endpoint in the Cluster Read/Write Connection section and the secondary node endpoint in the Cluster Read-only Connection section.

      You are connecting from an ECS instance, but do not meet the conditions for an internal network connection.

      Public endpoint

      You are connecting from a local device.

    • Username and Password: Obtain them from the Accounts page of the RDS instance.

Connect with Navicat

  1. Start the Navicat client.

  2. In the upper-left corner, click Connection and select your database type.

    Note

    If you use an earlier version of Navicat and the Alibaba Cloud menu is not available, you can directly select a database type, such as MySQL or PostgreSQL.

    In the Navicat toolbar, click Connection, select Alibaba Cloud from the drop-down menu, and then select the target database type from the submenu, such as Alibaba Cloud ApsaraDB for RDS (MySQL)..., Alibaba Cloud ApsaraDB for RDS (PostgreSQL)..., or Alibaba Cloud ApsaraDB for RDS (SQL Server)....

  3. Enter the connection information for the RDS instance. The following table describes the parameters.

    Parameter

    Description

    Connection Name

    A custom name for the connection.

    Host

    The internal endpoint or public endpoint of the RDS instance.

    • Use the internal endpoint if your client is on an ECS instance in the same account, region, and VPC as the RDS instance.

    • In other cases, use the public endpoint.

    Port

    The internal port or public port of the RDS instance. For example, the default port for MySQL is 3306.

    User Name

    The username for the account that accesses the RDS instance. You can find this on the instance's Accounts page.

    Password

    The password for the specified username.

  4. Click OK.

    Note

    If enhanced whitelist mode is enabled and you want to connect to the instance over the internet, add the public IP address of your client to the classic network group.

    After successfully connecting with a client such as Navicat, if you see databases such as busudab, information_schema, and mysql in the connection tree, the connection is successful.

Connect from ECS across regions or accounts

  • Public network (Internet) connection: You can use the public endpoint of the RDS instance to connect across regions or accounts over the Internet. Inbound and outbound Internet traffic to and from the RDS instance is free of charge.

  • Internal network (private network) connection: By default, you cannot connect over an internal network when the ECS instance and the RDS instance reside in different regions or different accounts because the VPCs are isolated from each other. However, you can use VPC peering or Cloud Enterprise Network (CEN) to connect two VPCs, so that the ECS instance can access the RDS instance across regions or accounts.

    • VPC peering connection: Supports cross-region and cross-account VPC interconnection at a low cost, but is relatively complex to configure. This option is suitable for simple scenarios that involve a small number of interconnected VPCs.

    • CEN: Supports cross-region and cross-account VPC interconnection with easy configuration, but at a relatively higher cost. This option is suitable for complex scenarios that involve multiple interconnected VPCs.

Common connection errors

mysql command not found

This error indicates that MySQL is not installed. To install it, use one of the following commands:

  • On CentOS, run sudo yum install mysql.

  • On Ubuntu, run sudo apt-get update, and then run sudo apt install mysql-server.

SSL connection error: SSL is required but the server doesn't support it

When you use some versions of MySQL Workbench, a Standard TCP/IP connection requires SSL encryption. The version of MySQL Workbench mentioned in this topic allows for connections without SSL.

Error 10060: Can't connect to MySQL server on 'rm-bpxxx.mysql.rds.aliyuncs.com'(10060)

  • (Most common cause) The IP address whitelist for the RDS instance is configured incorrectly. This typically means that the client's IP address has not been added to the whitelist.

    Solution: Check and correctly configure the IP address whitelist. If you are connecting from a local client, run curl ipinfo.io/ip to find the public IP address of your local client and add it to the whitelist.

  • In rare cases, you use an internal network address to connect without meeting the internal network connection requirements.

    Solution: Apply for a public endpoint and use it to connect.

Error 113: Can't connect to MySQL server on 'rm-bpxxx.mysql.rds.aliyuncs.com'(113)

A route conflict has occurred. For more information, see How to resolve the issue of being unable to ping the internal endpoint of an RDS instance.

Cannot Connect to Database Server

Your connection attempt failed for user 'xx" to the MySQL server

Pinging the internal endpoint of an RDS instance returns a "Destination Host Unreachable" error.

A route conflict has occurred. For more information, see How to resolve the issue of being unable to ping the internal endpoint of an RDS instance.

Access denied for user 'xxx'@'xxx'(using password:YES)

The username or password you entered is incorrect. You can manage database accounts and passwords on the Accounts page for the RDS instance.

Unknown MySQL server host 'xxx'(11001)

The RDS instance endpoint you entered is incorrect. The correct format is rm-xxxxxx.mysql.rds.aliyuncs.com.

FAQ

  • Q: Do ApsaraDB for RDS for MySQL instances support Elastic IP Addresses (EIPs)?

    A: No, this feature is not currently supported.

  • Q: How do I resolve a Telnet connection failure from my local computer to the RDS instance?

    A: If you cannot connect to the RDS instance by using Telnet, check the following:

    • Verify that the service port of the cloud database is correct and open to the internet.

    • Check the security group or firewall rules of the cloud database to ensure that your local IP address is allowed to connect.

    • Verify that the connection parameters, such as the hostname and port number, are correct.

    • Check the firewall rules on your local device to ensure that the port required by RDS is not blocked.

    • If possible, try to connect to the cloud database by using other tools, such as the mysql CLI or a database management tool, to rule out Telnet-specific issues.

  • Q: How can other users access my database?

    A: Follow these steps:

    1. Create a standard account and grant it permissions on the database.

    2. Apply for a public endpoint.

    3. Configure an IP address whitelist. If the other user is using an ECS instance, add the private IP address or the security group ID of the ECS instance. If the user is using a local MySQL client, add the public IP address of their host device.

    4. Share the public endpoint, database name, and account credentials with the user.

    5. The user can then connect to the database by using the CLI.

References

Previous：Connect to an ApsaraDB RDS for MySQL instanceNext：Use DMS to log on to an ApsaraDB RDS instance