ApsaraDB RDS for SQL Server instances expose internal and public endpoints that your application uses to connect. This topic explains how to view and modify those endpoints and ports, and how to view or disable read-only endpoints on Cluster Edition instances.
Endpoint types
| Endpoint type | Description | Related topics |
|---|---|---|
| Internal endpoint | Applicable to all scenarios where you connect to an instance. | Enable or disable a public endpoint |
| Public endpoint | Applicable to all scenarios where you connect to an instance. Must be enabled before use. | Enable or disable a public endpoint |
| Unified read-only endpoint | Routes read requests to the secondary node and read-only instances based on their assigned weights. Configure this endpoint in your application to enable read/write splitting. | Enable a read-only endpoint |
| Secondary node read-only endpoint | Provides direct access to the secondary node. Does not route traffic to the primary instance or read-only instances. | Enable a read-only endpoint |
If your application connects only through the internal or public endpoint of the primary instance, all requests go to the primary instance — none are distributed to the secondary node or read-only instances.
View or modify internal and public endpoints and ports
Prerequisites
Before you begin, ensure that you have:
A configured whitelist. See Configure a whitelist
(For public endpoint only) An enabled public endpoint. See Enable or disable a public endpoint
After you modify an endpoint or port, update the connection parameters in your application. Otherwise, your application cannot connect to the database.
Procedure
Go to the Instances page. In the top navigation bar, select the region where the instance resides. Find the instance and click its ID.
In the left navigation pane, click Database Connection to view the internal and public endpoints and ports.
Click Modify Endpoint.
Configure the connection settings, then click Ok.
Field Description Requirement Connection Type The endpoint to modify Select Internal Endpoint or Public Endpoint Endpoint The endpoint prefix Must start with a lowercase letter, be 8–64 characters long, and contain only letters, digits, and hyphens (-) Port The port number Must be between 1000 and 5999
View or disable a read-only endpoint (Cluster Edition)
Prerequisites
Before you begin, ensure that you have enabled either a unified read-only endpoint or a secondary node read-only endpoint.
Keep the following in mind before disabling a read-only endpoint:
Disabling a read-only endpoint invalidates it immediately. Your application can no longer use it to connect to the instance. Internal and public endpoints are not affected.
Disabling causes a transient disconnection lasting less than 30 seconds. Perform this operation during off-peak hours and make sure your application has an automatic reconnection mechanism.
Each time you re-enable a unified or secondary node read-only endpoint, the new endpoint may differ from the previous one.
Disable the unified read-only endpoint
Go to the Instances page. In the top navigation bar, select the region where the instance resides. Find the instance and click its ID.
In the left navigation pane, click Cluster Management.
In the Read-only Network Information section, click Disable Readonly Splitting Address.
In the dialog box, click OK.
Disable the secondary node read-only endpoint
Go to the Instances page. In the top navigation bar, select the region where the instance resides. Find the instance and click its ID.
In the left navigation pane, click Cluster Management.
In the Secondary Instance Network Information section, click Disable Secondary Instance Endpoint.
In the dialog box, click OK.
FAQ
Do I need to update my application after modifying an endpoint or port?
Yes. Update the connection parameters in your application immediately. Otherwise, connections will fail.
Do endpoint or port changes require a restart?
No. Changes take effect immediately without restarting the instance.
Can I reuse a released endpoint for another instance?
Yes. Once released, the endpoint becomes available for other instances.
Does a primary/secondary switchover change the endpoint?
No. The endpoint stays the same after a switchover. Only the underlying IP address changes, which does not affect your application.