Docs

RDS for MySQL

Database proxy

Enabling the database proxy

This topic describes how to enable the database proxy.

Billing

Billing for the database proxy feature starts at 00:00:00 (UTC+8) on November 20, 2024. For more information about the billing of the database proxy, refer to Billing items and prices.

Precautions

Single-node instances do not support the database proxy feature.

For multiple-node instances, the database proxy is enabled by default when you create the instance and cannot be disabled.

For double-node instances, enabling the database proxy automatically switches the connection pool to transaction-level mode and associates the default endpoint with all nodes except the secondary node.

The database proxy service only supports the pay-as-you-go billing method, and usage fees are periodically deducted from your account balance. To ensure the stability of your business, the database proxy service will not be suspended due to account arrears. Note that for pay-as-you-go instances, arrears will cause the instance to shut down. Monitor your account balance to avoid business disruptions. For subscription instances, you can continue to use the database proxy service and will continue to be charged even if your account has arrears. Top up your account promptly. If you do not need the database proxy service, you can disable it manually. For more information about how to disable the database proxy, refer to Disabling the database proxy.

Limitation

You may be unable to disable the database proxy if your instance has not been fully upgraded for six months or longer. If you need to use the database proxy feature, submit a ticket to contact technical support.

Some instances cannot use the database proxy feature due to their kernel version.

Prerequisites

When you enable the database proxy feature, RDS for MySQL performs a pre-check on the instance. If the check passes, refer to the Procedure in this article to enable the database proxy. If a check item fails, refer to the following content for a solution.

Check items	Check result	Solutions
Instance version	The database proxy cannot be enabled or disabled for the current instance version.	Check the following two points to resolve the issue. If the instance meets the following two conditions but the database proxy still cannot be enabled or disabled, submit a ticket to contact technical support for assistance. Confirm that the instance type is Double node. The database proxy cannot be enabled or disabled for instances that are not of the double-node type. Confirm that the allowlist version of the instance is v2. You can confirm the allowlist version of the instance by calling the DescribeDBInstanceDetail API and checking the value returned for the AllowListVersion field. If the allowlist version is v1, call the UpgradeAllowListVersion API to upgrade it to v2.
Instance state	The database proxy cannot be enabled or disabled because the instance is not in the Running state.	Confirm that the instance state is Running. If the instance state is not Running, check for any executing operations. After the operation is complete and the instance returns to the Running state, retry enabling or disabling the database proxy.
Instance state		Enabling or disabling the database proxy is not supported while network events are running.	Confirm if there are any running network events for the instance. Network events include creating and deleting public network addresses, creating, editing, and deleting endpoints, modifying the prefix or port of a connection address, and modifying the resolution method of a private network address. Retry enabling or disabling the database proxy after the running network events are complete.
Others	The database proxy cannot be enabled or disabled due to backend system limitations.	Submit a ticket to contact technical support for assistance.

Procedure

Log on to the RDS for MySQL console.

In the upper-left corner of the top menu bar, select the project and region for the instance.

tip

If the project to which the instance belongs is not set, this operation should select the project as All resources.

Click Instances in the left-side navigation bar.

On the Instances page, click the instance name of the target instance to enter the Instances page.

Click the Connectivity tab, and in the Database proxy area, click the icon to the right of Database proxyicon.

Complete the evaluation for enabling the database proxy feature.

tip

When enabling the database proxy, RDS for MySQL evaluates the instance state. If the evaluation is successful, the Database proxy window appears. Follow step 7. If the evaluation fails, the failed check items and check results are listed in the Enable database proxy window. You can make adjustments according to the solutions listed in the Prerequisites, and then click Retry in the window to perform the evaluation again. If the evaluation is successful, click OK to enable the database proxy. If the evaluation fails, make adjustments based on the failed check items and results.

In the Enable database proxy window, set the number of proxy cores, select whether to convert the default endpoint to a proxy endpoint, select the checkbox to agree to the billing rules, and click OK.

tip

The maximum number of proxy cores is 1024, and the minimum is the greater of 2 or half the number of CPU cores on the primary node. The adjustment increment is 2. The recommended number of proxy cores is the total number of CPUs of all serviceable nodes of the instance * 0.5 (round up the result). For example, if the primary node has an 8-core CPU and the instance has a 4-core CPU read-only node, since (8+4)*0.5=6, the recommended number of proxy cores is 6.

If you select Endpoint conversion, the default endpoint will be automatically converted to a proxy endpoint when you enable the proxy. Other endpoints will not be converted.

tip

After the database proxy is enabled, you can go to the Database proxy section on the Connectivity tab and click View monitoring to quickly check proxy-related monitoring information. You can view the information by instance or connection endpoint. For more information about monitoring items and viewing monitoring data, refer to Monitoring metrics and Viewing monitoring information. If the instance version is too low, "No data" may be displayed when you view proxy monitoring by endpoint. Submit a ticket to contact technical support to upgrade the instance.

Related API

API	Description
ModifyDBProxy	Call the ModifyDBProxy API to enable or disable the database proxy feature.

Last updated: 2025.09.28 16:49:37