文档中心

云数据库 MySQL 版

数据库代理

开启数据库代理

本文介绍开启数据库代理功能的操作步骤。

费用说明

数据库代理功能已于 2024 年 11 月 20 日 00:00:00 （北京时间）开始计费。关于数据库代理功能详细的计费信息，请参见计费项与价格。

注意事项

单节点实例不支持数据库代理功能。

对于多节点实例，数据库代理功能在创建实例时默认开启，且不支持关闭。

对于双节点实例，开启数据库代理功能后，会自动切换连接池模式为事务级连接池，并为默认连接终端关联除备节点外的所有节点。

数据库代理服务仅支持按量计费的计费方式，在使用过程中会定期从您的账户余额扣取使用费用。为保证您业务的稳定性，数据库代理服务不会因账户欠费而停止服务。但需要注意，如果您的实例为按量计费实例，欠费会导致实例关停，您需要关注账户余额，以免实例因欠费停机影响业务；如果您的实例为包年包月实例，账户欠费后仍然可以正常使用数据库代理服务并持续产生使用费用，请您及时为账户充值。如您确认不需要使用数据库代理服务，可手动关闭。关于如何关闭数据库代理的详细信息，请参见关闭数据库代理。

使用限制

如果您的实例已超过半年或以上未进行整体升级，可能无法开启数据库代理。如需使用数据库代理功能，请提交工单联系技术支持。

部分实例会因内核版本不能使用数据库代理功能。

前提条件

在开启数据库代理功能时，云数据库 MySQL 版会对实例进行预检查。如通过检查，可参考本文操作步骤开启数据库代理功能。如未能通过检查项，可参考以下内容解决。

检查项	检查结果	解决方案
实例版本	当前实例版本不支持开关代理	可通过以下两点进行排查解决。如果实例符合以下两点但仍不能开启或关闭数据库代理功能，请提交工单联系技术支持协助解决。确认实例类型为双节点实例。非双节点类型实例不支持开关数据库代理。确认实例的白名单版本为 v2。通过调用 DescribeDBInstanceDetail 接口、查看 AllowListVersion 字段的返回值，可确认实例的白名单版本。如果白名单版本为 v1，可调用 UpgradeAllowListVersion 接口升级白名单版本到 v2。
实例状态	当前实例状态非运行中不支持开关代理	确认实例状态为运行中。如实例处于非运行中状态，可检查实例当前是否有执行中的操作，待操作完成、实例回到运行中状态后，重新执行开启或关闭数据库代理。
实例状态		存在运行中的网络事件不支持开关代理	确认实例是否存在运行中的网络事件。网络事件包含创建和删除公网地址，创建、编辑和删除终端，修改连接地址的前缀或端口，修改私网地址的解析方式。待运行中的网络事件执行完毕，重新执行开启或关闭数据库代理操作。
其他	触发后台系统限制，无法进行开关代理操作	请提交工单联系技术支持协助解决。

操作步骤

登录云数据库 MySQL 版控制台。

在顶部菜单栏选择实例所属的项目和地域。

说明

如未设置实例的所属项目，本操作应选择项目为账号全部资源。

在左侧导航栏单击实例列表。

在实例列表页面，单击目标实例名称，进入实例信息页签。

单击连接管理页签，在数据库代理区域，单击数据库代理右侧的图标。

完成开启数据库代理功能的评估。

说明

在开启数据库代理时，云数据库 MySQL 版会对实例状态进行评估，如评估通过，会弹出数据库代理窗口，按步骤 7 操作；如评估不通过，会在开启数据库代理窗口中列出未通过的检查项和检查结果，您可根据相应本文前提条件列出的解决方案进行相应的调整或设置，之后在窗口中单击重试，再次进行评估。如评估通过，即可单击确定开启数据库代理功能；如评估不通过，则需要根据列出的未通过的检查项和检查结果，再次进行调整。

在弹出的开启数据库代理窗口中，设置代理核数、选择是否转换默认终端为代理终端并勾选收费规则的确认项后，单击确定。

说明

代理核数的最大值为 1024，最小值为实例主节点 CPU 核数的一半与 2 之间的较大值，调整步长为 2。推荐代理核数为实例所有可服务节点总 CPU 数 * 0.5（结果向上取整）。例如主节点为 8 核 CPU，该实例下有 1 个 4 核 CPU 的只读节点，由于「(8+4)*0.5」=6，则推荐代理核数是 6 核。

如勾选了转换终端，在开启代理过程中会自动将默认终端转换为代理终端，其他终端不做转换。

说明

数据库代理功能开启后，可以在连接管理页签的数据库代理区域，单击查看监控快速查看代理相关的监控信息，支持按实例维度和连接终端维度进行查看。关于监控项和查看监控的更多详细信息，请参见监控指标说明和查看监控信息。如果您的实例版本过低，可能会在查看终端维度的代理监控时遇到“无数据”的情况，请提交工单联系技术支持升级实例。

API	说明
ModifyDBProxy	调用 ModifyDBProxy 接口开启或关闭数据库代理功能。