ApsaraDB RDS for MySQL instances expose several endpoint types depending on the edition. This topic explains what each endpoint does and how to view, create, or modify endpoints in the console.
Endpoint types
The available endpoint types depend on your RDS instance edition.
Basic Edition and High-availability Edition
| Endpoint type | What you can do | Notes |
|---|---|---|
| Internal endpoint | Connect from resources within the same Virtual Private Cloud (VPC), such as an ECS instance, with low latency | Auto-generated at instance creation |
| Public endpoint | Connect from the Internet | Must be applied for manually |
| Database proxy endpoint | Connect with read/write splitting enabled, reducing the load on the primary instance | Supported on High-availability Edition only (not Basic Edition). Use this endpoint when the database proxy feature is enabled. |
Cluster Edition
| Endpoint type | What you can do | Notes |
|---|---|---|
| Read/write endpoint | Perform read and write operations against the primary node | One per cluster. After a primary/secondary switchover, the endpoint routes to the new primary automatically — no application changes needed. |
| Read-only endpoint | Run read-only queries with automatic load balancing across secondary nodes | Up to one per cluster. If a secondary node fails or is promoted to primary, the endpoint adjusts automatically. |
| Direct node connection endpoint | Connect to a specific node in the cluster | Use for diagnostics or node-level tuning. Supports read/write for primary nodes and read-only for secondary nodes. |
| Database proxy endpoint | Connect through the general-purpose database proxy, with read/write splitting, transaction splitting, or connection pool management | Enabled by default for Cluster Edition. Can be configured as read/write or read-only. |
Basic Edition and High-availability Edition
View endpoints and ports
Go to the Instances page. In the top navigation bar, select the region where your RDS instance resides. Click the instance ID.
On the Basic Information page, click View Details in the Basic Information section.
The public endpoint appears only after you apply for a public endpoint.
Change the endpoint prefix or port
If Secure Sockets Layer (SSL) encryption is enabled for the endpoint you want to change, disable SSL encryption first. Disabling SSL causes the RDS instance to restart — perform this during off-peak hours.
Go to the Instances page. In the top navigation bar, select the region where your RDS instance resides. Click the instance ID.
In the left-side navigation pane, click Database Connection.
Click Modify Connection Address.
In the dialog box, set the prefix and port number for the internal or public endpoint, then click OK.
The prefix must be globally unique. It cannot duplicate an existing endpoint prefix. The prefix must start with a lowercase letter, end with a lowercase letter or digit, contain only lowercase letters, digits, and hyphens (-), be at least 8 characters long, and the total connection address (prefix + suffix) must not exceed 63 characters.
Cluster Edition
Read/write endpoint
After a Cluster Edition instance is created, the read/write endpoint's internal endpoint is automatically generated. Apply for a public endpoint if needed.
Go to the Instances page. In the top navigation bar, select the region where your RDS instance resides. Click the instance ID.
On the Basic Information page, in the Instance Topology Management > Database Connection section:
View: Hover over the read/write connection box to see the endpoint details.
Modify or apply for a public endpoint: Click Edit. In the dialog box, you can Change Endpoint, Change VPC, or Apply for a public endpoint.
Read-only endpoint
Create, view, or delete the read-only endpoint
Creating or deleting the read-only endpoint does not affect the read/write endpoint.
Deleting the read-only endpoint releases all its internal and public endpoints and interrupts active connections on those endpoints.
Each cluster supports up to one read-only endpoint, which load-balances across all secondary nodes assigned to it.
Go to the Instances page. In the top navigation bar, select the region where your RDS instance resides. Click the instance ID.
On the Basic Information page, in the Instance Topology Management > Database Connection section:
Add an endpoint: Click Add Endpoint. In the dialog box, enter the internal endpoint prefix, port, VPC, and vSwitch. Select the secondary nodes to include, then click OK.
Delete: In the read-only connection box, click Delete, then confirm.
View: Hover over the read-only connection box to see the endpoint details.
Adjust nodes and weights on the read-only endpoint
Adding nodes or adjusting weights: Existing connections are not affected. New connections use the updated node settings.
Removing nodes: At least one secondary node must remain. Connections on the removed node are interrupted for 30 to 120 seconds; other nodes are unaffected.
At least one secondary node must have a weight greater than 0.
Node settings apply to both the internal and public endpoints of the read-only endpoint.
Go to the Instances page. In the top navigation bar, select the region where your RDS instance resides. Click the instance ID.
On the Basic Information page, in the Instance Topology Management > Database Connection section, click Edit in the read-only connection box.
Add nodes and adjust weights: Select the secondary nodes to add and click the
icon. Adjust the weights, then click OK.Remove nodes: Select the nodes to remove, click the
icon, then click OK.
Direct node connection endpoint
Go to the Instances page. In the top navigation bar, select the region where your RDS instance resides. Click the instance ID.
On the Basic Information page, in the Instance Topology Management > Database Nodes section:
Create: In the target node section, click Create Node Endpoint. Configure the internal endpoint settings, then click OK.
View, modify, or apply for a public endpoint: Click Manage. In the dialog box, you can Change Endpoint, Change VPC, or Apply for a public endpoint.
FAQ
API reference
| API operation | Description |
|---|---|
| CreateDBInstanceEndpoint | Create an endpoint for a Cluster Edition instance |
| DeleteDBInstanceEndpoint | Delete an endpoint of a Cluster Edition instance |
| ModifyDBInstanceEndpointAddress | Modify an endpoint of a Cluster Edition instance |