This topic describes how to view and manage internal endpoints, public endpoints, and ports for an ApsaraDB RDS for SQL Server instance in the ApsaraDB RDS console.
Background information
An ApsaraDB RDS for SQL Server instance provides endpoints and ports that you use as connection parameters when connecting to the instance. The required connection parameters depend on your connection method. For more information, see Connect to an ApsaraDB RDS for SQL Server instance.
The following table describes the types of endpoints. You can view, modify, or disable them based on your requirements.
Endpoint type | Usage notes | Related tutorials |
Internal and public endpoints | Applicable to all scenarios where you connect to an instance. | |
Read-only address | Read-only endpoints include a unified read-only endpoint and a secondary node read-only endpoint:
If your application uses only the internal or public endpoint of the primary instance, all requests go to the primary instance and are not distributed to the secondary node or read-only instances. |
View or modify internal and public endpoints and ports
Prerequisites
You have configured a whitelist. For more information, see Configure a whitelist.
Before viewing or modifying a public endpoint and its port, you must request a public endpoint. For more information, see Enable or disable a public endpoint.
Notes
If you modify an endpoint or port, you must update the corresponding endpoint or port 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 in which the RDS instance resides. Then, find the RDS instance and click the ID of the instance.
In the navigation pane on the left, click Database Connection to view the internal and public endpoints and ports of the instance.
Click Modify Endpoint.
Select the Connection Type. Then, set the Endpoint prefix and Port for either the Internal Endpoint or the Public Endpoint, and click Ok.
NoteThe endpoint prefix must start with a lowercase letter and be 8 to 64 characters long. It can contain letters, digits, and hyphens (-).
The port number must be between 1000 and 5999.
FAQ
Q: Do I need to update the endpoint or port in my application after I modify them?
A: Yes, you must update them. Otherwise, your application cannot connect to the database.
Q: Do the changes to an endpoint or port take effect immediately? Do I need to restart the instance?
A: The changes take effect immediately. You do not need to restart the instance.
Q: After I modify or release an endpoint, can I use the previous endpoint for another instance?
A: Yes, you can.
Q: Does a primary/secondary switchover affect the endpoint?
A: A primary/secondary switchover does not change the endpoint. Only the underlying IP address changes, and this does not affect your application.
View or disable a read-only endpoint (for Cluster Edition instances)
Prerequisites
You have enabled either a unified read-only endpoint or a secondary node read-only endpoint for the instance.
Notes
After you disable a read-only endpoint, whether it is a unified or secondary node endpoint, it becomes invalid. Your application can no longer use the endpoint to connect to the instance. The public and internal endpoints of the instance are not affected.
When you disable a read-only endpoint, a transient disconnection that lasts less than 30 seconds occurs. Disable the endpoint during off-peak hours and ensure that your application has an automatic reconnection mechanism to prevent service interruptions.
Each time you re-enable a unified or secondary node read-only endpoint, the endpoint may be different from the previous one.
Procedure
Disable the unified read-only endpoint
Log on to the ApsaraDB RDS console and 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 instance ID.
In the navigation pane on the left, click Cluster Management.
In the Read-only Network Information section, click Disable Readonly Splitting Address.
In the dialog box that appears, click OK.
Disable the secondary node read-only endpoint
Log on to the ApsaraDB RDS console and 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 instance ID.
In the navigation pane on the left, click Cluster Management.
In the Secondary Instance Network Information section, click Disable Secondary Instance Endpoint.
In the dialog box that appears, click OK.