文档中心

云数据库 MySQL 版

请输入

连接管理

ModifyDBProxy - 开启或关闭数据库代理功能

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

请求类型

异步请求。

注意事项

该接口仅用于开启或关闭数据库代理功能，以及在开启数据库代理功能时指定代理节点的 CPU 核数，不能用于在开启数据库代理功能后变更代理节点的配置。如果变更代理节点的配置功能，请使用 ModifyDBProxySpec 接口。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-cf4f3ddc****	实例 ID。
EnableDBProxy	Boolean	是	false	实例的代理功能的状态。取值范围： true：开启。 false：关闭。说明在开启或关闭数据库代理功能时，可能会遇到“操作不支持”或其他的报错，可通过调用 DescribeDBProxyConfig接口查询具体原因。
ProxyNodeCustom	Object of ProxyNodeCustomObject	否	请参见请求示例。	实例数据库代理服务的核数。说明在开启代理时，即 EnableDBProxy 取值为 true时需传入该参数。
ConvertDefaultEndpoint	Boolean	否	true	用于开启代理时，指定是否将默认终端转换为代理终端。取值： true：是。默认值。 false：否。

ProxyNodeCustomObject

参数	类型	是否必选	示例值	描述
CpuNum	Integer	否	4	实例数据库代理服务的 CPU 核数。取值如下：取值范围：上限 1024。对于多节点实例：推荐代理核数为实例所有可服务节点总 CPU 数0.25，结果向上取整。代理核数的取值下限为 2 与主节点 CPU 核数0.125之间的较大值。对于双节点实例：推荐代理核数为实例所有可服务节点总CPU数 * 0.5，结果向上取整。代理核数的取值下限为 2 与主节点 CPU 核数*0.5之间的较大值。

返回参数

参数	类型	示例值	描述
OrderId	String	Order2002000002284548640	订单 ID。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2026.10.16 15:31:05

这个页面对您有帮助吗？

有用

无用