ApsaraDB RDS:Enable the database proxy feature

Prerequisites

Before you begin, make sure that:

• The RDS instance runs PostgreSQL 10 or later

• The RDS instance uses cloud disks

• The RDS instance runs RDS High-availability Edition

• The RDS instance is a primary RDS instance

• The RDS instance does not reside in Hangzhou Zone C or Hangzhou Zone D. If it does, migrate the instance to another zone before enabling database proxy.

Billing

Proxy types

ApsaraDB RDS for PostgreSQL offers two proxy types. For a detailed comparison, see What are database proxies?

Specification = Recommended number of proxies x 2 CPU cores

Enable database proxy

1. Go to the Instances page. In the top navigation bar, select the region of your RDS instance, then click the instance ID.

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

3. Select a proxy type (General-purpose or Dedicated) and click Enable Now.

   • General-purpose -- The system automatically assigns the recommended specification. After enablement, you can adjust it.

   • Dedicated -- Configure the proxy specification during enablement.

   Note

   If prompted that service-linked role (SLR) authorization is incomplete, click Authorize, then click OK in the dialog box. Alibaba Cloud creates a service-linked role named AliyunServiceRoleForRdsProxyOnEcs that allows the database proxy to bind elastic network interfaces (ENIs) and establish network connections.

4. Click OK.

Verify enablement

After the database proxy is enabled, the Database Proxy page displays the proxy's basic information, node details, and connection endpoints.

Connection Information

Parameter	Description
Proxy Endpoint (Terminal) ID	The ID of the database proxy endpoint. Each RDS instance supports up to seven database proxy endpoints. Each endpoint can have one internal endpoint and one public endpoint. Hover over the endpoint ID to view its Read/Write Attributes and Read Weight Information. For configuration details, see Configure the connection settings for a database proxy endpoint and Use a database proxy endpoint to connect to an ApsaraDB RDS for PostgreSQL instance.
Read/Write Attributes	The read/write mode of the proxy endpoint: Read/Write or Read-only. For details, see Configure the read/write attributes and the read weight of the database proxy.
Internal Endpoint/Port	The internal endpoint and port for connecting to the RDS instance over the internal network through the database proxy. The internal endpoint is bound to the proxy endpoint ID. Click the icon next to the endpoint to modify the endpoint prefix or port. For details, see Manage the database proxy endpoints.
Public Endpoint/Port	The public endpoint and port for connecting to the RDS instance over the Internet through the database proxy. An internal endpoint is provided by default; apply for a public endpoint separately. After applying, click the icon next to the endpoint to modify the endpoint prefix or port. For details, see Manage the database proxy endpoints.

Important considerations

• After the database proxy feature is enabled, we recommend that you do not migrate the primary RDS instance across zones. If you migrate the primary RDS instance across zones, the primary RDS instance and its proxy instances are in different zones. This increases access latency and slows down responses.

  Note

  If a primary/secondary switchover is triggered by a service failure, the primary RDS instance and its database proxy instances may end up in different zones. To reduce latency, perform another primary/secondary switchover to bring them back into the same zone. For details, see Switch workloads over between primary and secondary ApsaraDB RDS for PostgreSQL instances.

• A read-only RDS instance must exist for the primary instance before you can configure connection settings for a database proxy endpoint. Without a read-only instance, you can enable the database proxy feature but cannot configure connection settings. To create one, see Create a read-only ApsaraDB RDS for PostgreSQL instance.

Next steps

• Configure the connection settings for a database proxy endpoint -- Set up read/write splitting rules, connection limits, and access policies for your proxy endpoints.

• Configure the read/write attributes and the read weight of the database proxy -- Control how read traffic is distributed across the primary and read-only instances.

• Manage the database proxy endpoints -- Apply for public endpoints, modify endpoint prefixes, or change ports.

API reference