All Products
Search
Document Center

ApsaraDB RDS:Manage database proxy endpoints

Last Updated:Feb 07, 2024

After the database proxy feature is enabled for an ApsaraDB RDS for MySQL instance, your client can connect to the database system over a database proxy endpoint. This topic describes the types of database proxy endpoints and how to configure a database proxy endpoint, internal endpoint, and public endpoint.

Prerequisites

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

Types of database proxy endpoints

  • Database proxy endpoints are classified into the following types: internal endpoints of the virtual private cloud (VPC) type, internal endpoints of the classic network type, and public endpoints.

  • 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. For more information, see Enable the database proxy feature.

Note

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 VPC type and one public endpoint for each database proxy endpoint.

Manage database proxy endpoints

Create a database proxy endpoint

For more information about how to create a database proxy endpoint, see Create a database proxy endpoint.

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 instance ID.

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

  3. In the Connection Information section, click the image.png 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 2 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.

      • If you upgrade a database proxy of your RDS instance from a shared database proxy to a dedicated database proxy and modify the database proxy endpoint for the first time, the suffix of the database proxy endpoint is automatically changed. Take note of the change made to the suffix of the 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 instance ID.

  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
  • If your RDS instance uses cloud disks, the internal endpoint of the VPC type of the RDS instance cannot be deleted.

  • If your RDS instance uses local disks, you must retain at least one database proxy endpoint for the RDS instance.

  • Once the database proxy endpoint is deleted, the database proxy endpoint ID, internal endpoint, and public endpoint are also deleted.

Apply for an internal endpoint of the VPC type

If a database proxy endpoint does not have an internal endpoint of the VPC type, you can apply for an internal endpoint of the VPC type. A database proxy endpoint is formerly named as a proxy terminal.

You can apply for an internal endpoint in the following two ways:

Perform operations on the Database Proxy page

  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 instance ID.

  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 VPC-type Endpoint in the Internal Endpoint/Port column.

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

    Note
    • We recommend that the zone in which the vSwitch resides be the same as the primary zone of the RDS instance. After you apply for an internal endpoint, you cannot change the VPC and vSwitch.

    • You can apply for only one internal endpoint of the VPC type for each database proxy endpoint.

    • The prefix of a database proxy endpoint must be 2 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.

Perform operations on the Database Connection page

  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 instance ID.

  2. In the left-side navigation pane of the instance details page, click Database Connection.

  3. In the Database Proxy Endpoint section, click Apply for VPC-type Endpoint in the Internal Endpoint/Port column.

  4. In the dialog box that appears, configure VPC, vSwitch, Proxy Endpoint, and Port, and click OK.

Manage a public endpoint

Apply for a public endpoint

You can apply for a public endpoint in the following two ways:

Perform operations on the Database Proxy page

  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 instance ID.

  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 in the Internet Endpoint/Port column.

  4. In the dialog box that appears, configure Proxy Endpoint and Port, and then click OK.

Perform operations on the Database Connection page

  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 instance ID.

  2. In the left-side navigation pane of the instance details page, click Database Connection.

  3. In the Database Proxy Connection section, click Apply for Public Endpoint, configure Proxy Endpoint and Port, and then click OK. The value of Proxy Endpoint that you can modify refers to the prefix of the database proxy endpoint.

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

  • The prefix of a database proxy endpoint must be 2 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.

Release a public endpoint

You can release a public endpoint in the following two ways:

Perform operations on the Database Proxy page

  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 instance ID.

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

  3. Find the required database proxy endpoint and click Release Public Endpoint in the Public Endpoint/Port column. In the dialogue box that appears, click OK.

Perform operations on the Database Connection page

  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 instance ID.

  2. In the left-side navigation pane of the instance details page, click Database Connection.

  3. In the Database Proxy Endpoint section, click Release Public Endpoint in the Public Endpoint/Port column. In the dialogue box that appears, click OK.

References

Related operations

Operation

Description

DescribeDBProxy

Queries the details about the database proxy of an instance.

DescribeDBProxyEndpoint

Queries the information about the database proxy endpoints of an instance.

ModifyDBProxyEndpoint

Modifies the proxy endpoint settings of the database proxy of an instance.

CreateDBProxyEndpointAddress

Creates a database proxy endpoint.

ModifyDBProxyEndpointAddress

Modifies a database proxy endpoint.

DeleteDBProxyEndpointAddress

Deletes a database proxy endpoint.