文档中心

云数据库 MySQL 版

连接管理

DescribeDBProxyConfig - 查询指定 MySQL 实例的数据库代理信息

DescribeDBProxyConfig - 查询指定 MySQL 实例的数据库代理信息

调用 DescribeDBProxyConfig 接口查询指定 MySQL 实例的数据库代理信息。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-46609cf2****	实例 ID。

返回参数

参数	类型	示例值	描述
BinlogDump	Boolean	true	是否支持 binlog 能力，取值： true：是。 false：否。说明在实例的数据库代理功能开启时才会返回该参数。
CheckModifyDBProxyAllowed	Object of CheckModifyDBProxyAllowed	请参见返回示例。	是否允许执行 ModifyDBProxy 接口的判断信息。说明该字段已弃用。
CheckModifyDBProxyAllowedV2	Array of CheckModifyDBProxyAllowedV2	请参见返回示例。	是否允许执行 ModifyDBProxy 接口的检查结果。
ConnectionPoolType	String	Transaction	连接池类型，当开启了数据库代理后，才会返回该参数，取值范围： Direct：直连模式。 Transaction：事务级连接池。
DBProxyStatus	String	Creating	代理实例的运行状态。取值： Creating：代理开启中。 Running：代理运行中。 Shutdown：代理已关闭。 Deleting：代理关闭中。 Updating：代理变更中。说明只有在实例的数据库代理功能开启时才返回该参数，
FeatureStates	Array of FeatureStatesObject	请参见返回示例。	功能状态。
GlobalReadOnly	Boolean	true	是否开启全局只读。 true：是。 false：否。
InstanceId	String	mysql-46609cf2****	实例 ID。
ProxyResourceInfo	Object of ProxyResourceInfo	请参见返回示例。	实例数据库代理服务的配置信息。

CheckModifyDBProxyAllowed

参数	类型	示例值	描述
Allowed	Boolean	true	是否允许开启或关闭数据库代理功能。取值： true：允许。 false：不允许。
Reason	String	Other	当 Allowed 为 false 时，返回不允许开启或关闭数据库代理功能原因的分类。
Message	String	当前实例状态非运行中不支持开关代理	当 Allowed 为 false 时，返回不允许开启或关闭数据库代理功能的具体原因。

CheckModifyDBProxyAllowedV2

参数	类型	示例值	描述
Allowed	Boolean	false	是否允许开启或关闭数据库代理功能。取值： true：允许。 false：不允许。
CheckItem	String	InstanceConfig	开启或关闭数据库代理功能时的检查项。 InstanceVersion：实例版本 InstanceStatus：实例状态 AllowlistLimit：白名单限制 InstanceConfig：实例配置 SystemConstraint：系统约束 Other：其他
Reason	String	当前实例已开启事务级连接池，不支持开关代理	不允许开启或关闭数据库代理功能的详细原因。

FeatureStatesObject

参数	类型	示例值	描述
FeatureName	String	ProxyBinlogDump	功能名称。
Enable	Boolean	false	是否开启。取值： true：开启。 false：关闭。
Support	Boolean	true	是否支持该功能。取值： true：支持。 false：不支持。

ProxyResourceInfo

参数	类型	示例值	描述
CurrentProxyCpuNum	Integer	2	实例数据库代理服务当前的核数。
MaxProxyCpuNum	Integer	1024	用户可为数据库代理服务配置的最多核数。
MinProxyCpuNum	Integer	2	用户可为数据库代理服务配置的最少核数。

示例

请求示例

返回示例

错误码

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

最近更新时间：2026.06.10 10:58:16

这个页面对您有帮助吗？

有用

有用

无用

无用