After you enable the database proxy for an ApsaraDB RDS for MySQL instance, applications must connect to the database through a database proxy endpoint. This topic describes the types of database proxy endpoints and explains how to manage their internal and public endpoints.
Prerequisites
Types of database proxy endpoints
There are three types of database proxy endpoints: internal endpoint (VPC), internal endpoint (classic network), and public endpoint.
When you enable the database proxy, a default database proxy endpoint (formerly a proxy terminal) is created. By default, new database proxy endpoints are created with a VPC internal endpoint. You can apply for a public endpoint later.
Each ApsaraDB RDS for MySQL instance supports one to seven database proxy endpoints. For each database proxy endpoint, you can apply for one internal endpoint (VPC) and one public endpoint.
Effective December 7, 2023, you can no longer create classic network database proxy endpoints for ApsaraDB RDS for MySQL. You can continue to use existing database proxy endpoints in a classic network. However, if you release a classic network endpoint, you cannot request a new one. For more information, see [Discontinuation] The database proxy for ApsaraDB RDS for MySQL no longer supports creating new internal endpoints for classic networks.
Manage database proxy endpoints
Create a proxy endpoint (formerly a proxy terminal)
After you enable the database proxy, you can create additional database proxy endpoints, each with its own access policy.
A single ApsaraDB RDS for MySQL instance supports one to seven database proxy endpoints.
A database proxy endpoint has the following format:
rm-*****.rwlb.cn-chengdu.rds.aliyuncs.com:3306.rm-*****: A customizable endpoint prefix. It must be 2 to 40 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens (-).rwlb: The identifier for the read/write splitting proxy.cn-chengdu: The region.rds.aliyuncs.com: The domain name for the Alibaba Cloud RDS service.3306: The default MySQL port.
Go to the Instances page. In the top navigation bar, select the instance's region, and then click the instance ID.
In the left navigation bar, click Database Proxy.
At the top of the Connection Information section, click Create Proxy Endpoint.
In the dialog box that appears, configure the access policy for the database proxy endpoint and click OK. For more information about the configuration parameters, see Configure an access policy for a database proxy endpoint.
Switch the vSwitch of a proxy endpoint
Go to the Instances page. In the top navigation bar, select the instance's region, and then click the instance ID.
In the left navigation bar, click Database Proxy.
In the Connection Information section, under Network Settings of the target database proxy endpoint, click Switch vSwitch.
ImportantYou can switch the vSwitch for a database proxy endpoint only on cloud disk-based instances. This action is not supported on local disk-based instances.
Switching the vSwitch for a database proxy endpoint causes a transient disconnection of about 30 seconds. Direct connections to your ApsaraDB RDS for MySQL instance are not affected. To avoid service interruptions, we recommend performing this operation during off-peak hours or temporarily switching application connections to the endpoint of the primary instance or a read-only instance. Ensure that your application has an automatic reconnection mechanism. Otherwise, you must manually reconnect your application to the database proxy.
In the dialog box that appears, select Destination vSwitch and Change Time, and click OK.
Modify a proxy endpoint or port
Go to the Instances page. In the top navigation bar, select the instance's region, and then click the instance ID.
In the left navigation bar, click Database Proxy.
In the Connection Information section, click the
icon to the right of the target database proxy endpoint.In the dialog box that appears, set the connection address prefix and Port, and then click OK.
If you upgraded from a shared to a dedicated database proxy, note that the endpoint's suffix changes the first time you modify it.
Delete a proxy endpoint
Go to the Instances page. In the top navigation bar, select the instance's region, and then click the instance ID.
In the left navigation bar, click Database Proxy.
Click Delete Connection to the right of the target database proxy endpoint, and in the dialog box that appears, click OK.
You must keep at least one database proxy endpoint.
This operation deletes the entire database proxy endpoint, including the endpoint ID, internal endpoint, and public endpoint.
Manage public endpoints
Apply for a public endpoint
You can apply on the Database Proxy page or the Database Connection page:
Database Proxy page
Go to the Instances page. In the top navigation bar, select the instance's region, and then click the instance ID.
In the left navigation bar, click Database Proxy.
In the Connection Information section, in the Public Endpoint/Port column of the target database proxy endpoint ID, click Apply for Public Endpoint.
In the dialog box that appears, set the public connection address prefix and Port, and then click OK.
Database Connection page
Go to the Instances page. In the top navigation bar, select the instance's region, and then click the instance ID.
In the left navigation bar, click Database Connection.
In the Database Proxy Endpoint area, click Apply for Public Endpoint, set the public endpoint prefix and Port, and click OK.
Each database proxy endpoint supports only one public endpoint.
The endpoint prefix must be 2 to 40 characters long, start with a lowercase letter, and can contain only lowercase letters, digits, and hyphens (-).
The port number must be between 1000 and 5999.
Release a public endpoint
You can release a public endpoint on the following two pages:
Database Proxy page
Go to the Instances page. In the top navigation bar, select the instance's region, and then click the instance ID.
In the left navigation bar, click Database Proxy.
To the right of the public endpoint to be released, click Release Public Endpoint, and in the dialog box, click OK.
Database Connection page
Go to the Instances page. In the top navigation bar, select the instance's region, and then click the instance ID.
In the left navigation bar, click Database Connection.
In the Database Proxy Endpoint section, click Release Public Endpoint to the right of the public endpoint that you want to release, and then click OK in the dialog box.
Related documents
API reference
API | Description |
Queries the details of the database proxy for an ApsaraDB RDS instance. | |
Queries information about the database proxy endpoints (formerly proxy terminals) for an ApsaraDB RDS instance. | |
Modifies the access policy of a database proxy endpoint for an ApsaraDB RDS instance. | |
Creates a database proxy endpoint. | |
Modifies a database proxy endpoint. | |
Deletes a database proxy endpoint. |