文档中心

云数据库 PostgreSQL 版

连接管理

DescribeDBInstanceProxyParameters

调用 DescribeDBInstanceProxyParameters 接口查询实例默认终端开启读写分离后的连接数参数的配置。

请求类型

同步请求。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-0af11cd4****	实例 ID。
ParameterName	String	否	ReadWriteProxyConnection	连接终端开启读写分离后，连接终端的代理相关参数。说明当前仅支持取值为 ReadWriteProxyConnection，即连接数参数。该参数默认值为空。取空值时，接口的返回值也为空。
EndpointId	String	否	postgres-0af11cd4****-cluster	连接终端 ID。说明该参数默认值为实例默认终端的 ID。当前仅支持传入实例默认终端的 ID。

返回参数

参数	类型	示例值	描述
InstanceId	String	postgres-0af11cd4****	实例 ID。
DBEngineVersion	String	PostgreSQL_12	兼容版本。取值： PostgreSQL_11：PostgreSQL 11。 PostgreSQL_12：PostgreSQL 12。 PostgreSQL_13：PostgreSQL 13。 PostgreSQL_14：PostgreSQL 14。 PostgreSQL_15：PostgreSQL 15。 PostgreSQL_16：PostgreSQL 16。 PostgreSQL_17：PostgreSQL 17。 PostgreSQL_18：PostgreSQL 18。
ParameterCount	String	1	参数个数。
Parameters	Array of ParameterObject	请参见返回示例。	该 Proxy 当前运行的参数列表。

ParameterObject

参数	类型	示例值	描述
CheckingCode	String	[on\|off]	参数取值范围。
DefaultValue	String	off	参数默认值。指在该实例对应的默认模板中提供的默认值。
Description	String	Use EXPLAIN ANALYZE for plan logging.	参数的英文描述。
DescriptionZH	String	启用 EXPLAIN ANALYZE 输出的采样。	参数的中文描述。
ForceRestart	Boolean	false	是否重启才生效，取值：true 或 false。
Name	String	auto_explain.log_analyze	参数名。
Type	String	bool	参数值类型。取值：string、integer、real、bool、enum。
Value	String	off	参数值。特指当前实例运行值。

示例

请求示例

返回示例

最近更新时间：2026.10.16 14:22:31

这个页面对您有帮助吗？

有用

无用