Use a client or the CLI to connect to an ApsaraDB RDS for MySQL instance - ApsaraDB RDS

This topic describes how to configure IP address whitelists for an ApsaraDB RDS for MySQL instance. This topic also describes how to use a database client or the CLI to connect to the RDS instance.

Prerequisites

An RDS instance is created. For more information, see Create an ApsaraDB RDS for MySQL instance.
A database and an account are created for the RDS instance. For more information, see Create databases and accounts for an ApsaraDB RDS for MySQL instance.
An IP address whitelist is configured for the RDS instance. For more information, see Configure an IP address whitelist for an ApsaraDB RDS for MySQL instance.

Suggestions

If you want to connect to the RDS instance from an Elastic Compute Service (ECS) instance, and the ECS instance and the RDS instance meet the conditions for communication over an internal network, we recommend that you use an internal endpoint to connect to the RDS instance to achieve the low latency and high stability.

Procedure

Use the CLI to connect to an RDS instance

The following example describes how to connect to an RDS instance from a server that runs Linux. You must install MySQL on the server before the connection. You can run the following commands to install MySQL:

If you use a CentOS operating system, run the sudo yum install mysql command.
If you use an Ubuntu operating system, run the sudo apt-get update command and then the sudo apt install mysql-server command.

Log on to the server from which you want to connect to the RDS instance. For example, the server can be an ECS instance or an on-premises device.
Note
For more information about how to log on to an ECS instance, see the "Connect to an instance" section in Create and manage an ECS instance by using the ECS console (express version).

Run the connection command:

mysql -hEndpoint -PPort -uUsername -pPassword

Note

You can enter the password after you run the command.
The uppercase letter P specifies the port number, and the lowercase letter p specifies the password.

Endpoint and port number: Enter the endpoint and port number that are used to connect to the RDS instance.

Scenario	Endpoint to be obtained	Method to obtain the endpoint
You want to connect to the RDS instance from an ECS instance. The ECS instance and the RDS instance meet the conditions for communication over an internal network.	Internal endpoint of the RDS instance	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 ID of the instance. In the Basic Information section of the page that appears, click View Details to the right of the Network Type parameter to view the endpoint and port number that are used to connect to the RDS instance. Note Before you can view the endpoint and port number that are used to connect to the RDS instance, you must configure IP address whitelists for the RDS instance. The public endpoint is displayed only after a public endpoint is applied for the RDS instance by clicking Apply for Public Endpoint. You can modify the read/write endpoint of an RDS cluster in the Cluster Read/Write Connection section and modify the read-only endpoint of the RDS cluster in the Cluster Read-only Connection section.
You want to connect to the RDS instance from an ECS instance. The ECS instance and the RDS instance do not meet the conditions for communication over an internal network.	Public endpoint of the RDS instance
You want to connect to the RDS instance from an on-premises device.	Public endpoint of the RDS instance

Username and password: Obtain the username and password of the account that is used to connect to the RDS instance from the Accounts page.

Use a client to connect to an RDS instance

You can use a general-purpose MySQL client to connect to an RDS instance. The following example describes how to use MySQL Workbench 8.0.29 to connect to an RDS instance. If you use a different client, the connection operations are similar.

Install MySQL Workbench. For more information, visit the MySQL Workbench download page.
Start MySQL Workbench and choose Database > Connect to Database.

Enter the connection information and click OK.

Hostname and Port: Enter the endpoint and port number that are used to connect to the RDS instance.

Scenario	Endpoint to be obtained	Method to obtain the endpoint
You want to connect to the RDS instance from an ECS instance. The ECS instance and the RDS instance meet the conditions for communication over an internal network.	Internal endpoint of the RDS instance	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 ID of the instance. In the Basic Information section of the page that appears, click View Details to the right of the Network Type parameter to view the endpoint and port number that are used to connect to the RDS instance. Note Before you can view the endpoint and port number that are used to connect to the RDS instance, you must configure IP address whitelists for the RDS instance. The public endpoint is displayed only after a public endpoint is applied for the RDS instance by clicking Apply for Public Endpoint. You can modify the read/write endpoint of an RDS cluster in the Cluster Read/Write Connection section and modify the read-only endpoint of the RDS cluster in the Cluster Read-only Connection section.
You want to connect to the RDS instance from an ECS instance. The ECS instance and the RDS instance do not meet the conditions for communication over an internal network.	Public endpoint of the RDS instance
You want to connect to the RDS instance from an on-premises device.	Public endpoint of the RDS instance

Username and Password: Obtain the username and password of the account that is used to connect to the RDS instance from the Accounts page.

Common connection errors

mysql command not found

This error occurs because MySQL is not installed. Run the following commands to install MySQL:

If you use a CentOS operating system, run the sudo yum install mysql command.
If you use an Ubuntu operating system, run the sudo apt-get update command and then the sudo apt install mysql-server command.

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

You are using specific versions of MySQL Workbench. In these versions, standard TCP/IP connections require SSL encryption. However, the connected server does not support SSL encryption. In this case, you can download the version of MySQL Workbench that is described in this section to establish regular connections.

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

In most cases, this error occurs because the IP address whitelists that you configure are inappropriate. For more information, see Configure an IP address whitelist for an ApsaraDB RDS for MySQL instance.
In a few cases, this error occurs because the RDS instance and the ECS instance do not meet the conditions for communication over an internal network but you attempt to connect to the internal endpoint of the RDS instance.

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

This error occurs because route conflicts occur. For more information, see What do I do if I am unable to connect to an ApsaraDB RDS instance and the "Destination Host Unreachable" error message is displayed when I ping the internal endpoint of the instance?

Cannot Connect to Database Server

In most cases, this error occurs because the IP address whitelists that you configure are inappropriate. For more information, see Configure an IP address whitelist for an ApsaraDB RDS for MySQL instance.
In a few cases, this error occurs because the RDS instance and the ECS instance do not meet the conditions for communication over an internal network but you attempt to connect to the internal endpoint of the RDS instance.

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

In most cases, this error occurs because the IP address whitelists that you configure are inappropriate. For more information, see Configure an IP address whitelist for an ApsaraDB RDS for MySQL instance.
In a few cases, this error occurs because the RDS instance and the ECS instance do not meet the conditions for communication over an internal network but you attempt to connect to the internal endpoint of the RDS instance.

The "Destination Host Unreachable" error message reported when you ping the internal endpoint of the RDS instance

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

This error occurs because the username and password that you entered are incorrect. You can obtain the correct username and password from the Accounts page.

Unknown MySQL server host 'xxx'(11001)

This error occurs because the endpoint that you entered is invalid. Valid endpoints are in the rm-xxxxxx.mysql.rds.aliyuncs.com format.

References

For more information about how to troubleshoot connection errors, see What do I do if I fail to connect to an ApsaraDB RDS instance?
For more information about how to connect to an RDS instance in a more convenient and efficient manner, see Use DMS to log on to an ApsaraDB RDS for MySQL instance.
For more information about how to connect to an RDS instance that runs a different database engine, see the following topics: