After you enable the database proxy for an ApsaraDB RDS for MySQL instance, clients connect through a proxy endpoint. This topic explains endpoint types and how to add, modify, switch, and release proxy endpoints, including public endpoints.
Limitations
-
A single ApsaraDB RDS for MySQL instance supports 1 to 7 proxy endpoints. Enabling the database proxy creates one endpoint by default.
-
Each proxy endpoint supports one internal endpoint (virtual private cloud (VPC)) and one public endpoint.
-
You must keep at least one proxy endpoint. Releasing a proxy endpoint permanently removes its ID, internal endpoint, and public endpoint.
-
Switching the vSwitch for a proxy endpoint is supported only on cloud disk instances.
-
Classic network endpoints can no longer be created as of December 7, 2023. Existing classic network endpoints continue to work but cannot be restored once released.
Prerequisites
Before you begin, ensure that you have:
Endpoint types
Each proxy endpoint supports up to two addresses:
-
Internal endpoint (VPC) — connects clients inside your VPC to the proxy. Created by default when you enable the database proxy or add a new proxy endpoint.
-
Internal endpoint (classic network) — connects clients in the classic network to the proxy. No longer available for new endpoints as of December 7, 2023. For details, see [Deprecation/Offline] ApsaraDB RDS for MySQL database proxy stops supporting new internal endpoints (classic network).
-
Public endpoint — connects clients over the internet. Must be requested separately for each proxy endpoint.
Endpoint address format
A proxy endpoint address uses the following structure. Using rm-*****.rwlb.cn-chengdu.rds.aliyuncs.com:3306 as an example:
| Segment | Description | Example |
|---|---|---|
rm-***** |
Customizable prefix. Must start with a lowercase letter, be 2–40 characters long, and contain only letters, digits, and hyphens (-). | rm-bp1abc123 |
rwlb |
Identifier for the read/write splitting proxy. | rwlb |
cn-chengdu |
Region where the instance is deployed. | cn-hangzhou |
rds.aliyuncs.com |
Domain name for the Alibaba Cloud RDS service. | — |
3306 |
Default port for MySQL. Configurable within the range 1000–5999 for public endpoints. | 3306 |
Add a proxy endpoint
-
Go to the RDS Instances page. Select a region, then click the ID of the target instance.
-
In the left navigation pane, click Database Proxy.
-
At the top of the Connection Information section, click Add Database Proxy Endpoint.
-
In the dialog box, configure the access policy for the endpoint, then click OK. For configuration details, see Configure an access policy for a database proxy endpoint.
Switch the vSwitch for a proxy endpoint
Only cloud disk instances support this operation. Switching the vSwitch causes a transient disconnection of approximately 30 seconds for connections through the proxy endpoint. Connections through the primary or read-only instance endpoints are not affected. Perform this operation during off-peak hours, or temporarily route application traffic to the primary or read-only instance endpoint. Make sure your application has an automatic reconnection mechanism.
-
Go to the RDS Instances page. Select a region, then click the ID of the target instance.
-
In the left navigation pane, click Database Proxy.
-
In the Connection Information section, under Network Information for the target proxy endpoint, click Switch vSwitch.
-
In the dialog box, select a Target vSwitch and a Change Time, then click OK.
Modify a proxy endpoint address or port
-
Go to the RDS Instances page. Select a region, then click the ID of the target instance.
-
In the left navigation pane, click Database Proxy.
-
In the Connection Information section, click the
icon next to the target proxy endpoint. -
In the dialog box, set the connection address prefix and Port, then click OK.
If you upgraded from a shared proxy to a dedicated proxy, the suffix of the proxy endpoint changes the first time you modify it.
Release a proxy endpoint
Releasing a proxy endpoint permanently removes its ID, internal endpoint, and public endpoint. You must keep at least one proxy endpoint.
-
Go to the RDS Instances page. Select a region, then click the ID of the target instance.
-
In the left navigation pane, click Database Proxy.
-
Click Delete Connection next to the target proxy endpoint. In the dialog box, click OK.
Manage public endpoints
Each proxy endpoint supports one public endpoint. When requesting a public endpoint, the prefix must start with a lowercase letter, be 2–40 characters long, and contain only letters, digits, and hyphens (-). The port must be in the range 1000–5999.
Request a public endpoint
You can request a public endpoint from either the Database Proxy page or the Database Connection page.
From the Database Proxy page:
-
Go to the RDS Instances page. Select a region, then click the ID of the target instance.
-
In the left navigation pane, click Database Proxy.
-
In the Connection Information section, find the target proxy endpoint. In the Public Endpoint/Port column, click Request Public Endpoint.
-
Set the public endpoint prefix and Port, then click OK.
From the Database Connection page:
-
Go to the RDS Instances page. Select a region, then click the ID of the target instance.
-
In the left navigation pane, click Database Connection.
-
In the Database Proxy Endpoint section, click Apply for Public Endpoint. Set the prefix and Port, then click OK.
Release a public endpoint
You can release a public endpoint from either the Database Proxy page or the Database Connection page.
From the Database Proxy page:
-
Go to the RDS Instances page. Select a region, then click the ID of the target instance.
-
In the left navigation pane, click Database Proxy.
-
Next to the public endpoint you want to release, click Release Public Endpoint. In the dialog box, click OK.
From the Database Connection page:
-
Go to the RDS Instances page. Select a region, then click the ID of the target instance.
-
In the left navigation pane, click Database Connection.
-
In the Database Proxy Connection section, next to the public endpoint you want to release, click Release Public Endpoint. In the dialog box, click OK.
What's next
API reference
| API | Description |
|---|---|
| DescribeDBProxy | Queries database proxy details for an RDS instance. |
| DescribeDBProxyEndpoint | Queries proxy endpoint information for an RDS instance. |
| ModifyDBProxyEndpoint | Modifies proxy endpoint settings for an RDS instance. |
| CreateDBProxyEndpointAddress | Creates an address for a database proxy endpoint. |
| ModifyDBProxyEndpointAddress | Modifies an address of a database proxy endpoint. |
| DeleteDBProxyEndpointAddress | Deletes an address of a database proxy endpoint. |