ApsaraDB RDS:Manage database proxy endpoints

Prerequisites

The database proxy feature is enabled. For more information, see Enable the database proxy feature.

Usage notes

• Each RDS instance with the database proxy feature enabled supports up to seven database proxy endpoints. You can apply for one internal endpoint of the virtual private cloud (VPC) type and one public endpoint for each database proxy endpoint.

• When you enable the database proxy feature for your RDS instance, a database proxy endpoint is automatically generated, which is also called the default database proxy endpoint and cannot be deleted. Database proxy endpoints are formerly known as proxy terminals.

• When you create a database proxy endpoint, the system allocates an internal endpoint of the VPC type for the database proxy endpoint. You cannot delete the internal endpoint.

Create a database proxy endpoint

1. 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.

2. In the left-side navigation pane, click Database Proxy.

3. In the Connection Information section, click Create Proxy Endpoint.

4. In the dialog box that appears, configure the connection settings.

   Note

   For more information about the connection settings, see Configure the connection settings for a database proxy endpoint.

5. Click OK.

Modify a database proxy endpoint and the port that is associated with the database proxy endpoint

1. 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.

2. In the left-side navigation pane, click Database Proxy.

3. In the Connection Information section, find the required database proxy endpoint and click the icon to the right of the database proxy endpoint.

4. In the dialog box that appears, modify the values of Endpoint and Port. Then, click OK. The value of Endpoint that you can modify refers to the prefix of the database proxy endpoint.

   Note

   • The prefix of a database proxy endpoint must be 1 to 40 characters in length and can contain letters, digits, and hyphens (-). The prefix must start with a lowercase letter.

   • The port number that is associated with a database proxy endpoint must be within the range of 1000 to 5999.

   • The value of Endpoint Type cannot be modified.

Apply for and release a public endpoint

1. 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.

2. In the left-side navigation pane, click Database Proxy.

3. In the Connection Information section, find the required database proxy endpoint and click Apply for Public Endpoint or Release Public Endpoint in the Public Endpoint/Port column.

   If you click Apply for Public Endpoint, you must configure Proxy Endpoint and Port for the public endpoint that you want to apply for. Then, click OK.

   Note

   • You can apply for only one public endpoint for each database proxy endpoint.

   • The prefix must be 2 to 40 characters in length and can contain letters, digits, and hyphens (-). It must start with a lowercase letter.

   • The port number that is associated with the public endpoint must be within the range of 1000 to 5999.

   • You can release the public endpoint but cannot release the internal endpoint for each database proxy endpoint.

Delete a database proxy endpoint

1. 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.

2. In the left-side navigation pane, click Database Proxy.

3. Find the database proxy endpoint that you want to delete and click Delete Connection in the Actions column. In the message that appears, click OK.

   Note

   The default database proxy endpoint that is generated when you enable a database proxy cannot be released.

References

• Configure the connection settings for a database proxy endpoint

• Use a database proxy endpoint to connect to an ApsaraDB RDS for PostgreSQL instance

Related operations