Call the DescribeDBInstanceProxyParameters API to query the connection parameter configuration after read-write separation is enabled on the default endpoint of an instance.

Request type

Synchronous request.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameter	Type	Required?	Example	Description
InstanceId	String	Yes	postgres-0af11cd4****	Instance ID.
ParameterName	String	No	ReadWriteProxyConnection	Proxy-related parameters for the connection endpoint after enabling read/write separation. tip Currently only supports the value ReadWriteProxyConnection, which refers to the number of connections parameter. The parameter default value is empty. When set to empty, the API return value is also empty.
EndpointId	String	No	postgres-0af11cd4****-cluster	Connect endpoint ID. tip The parameter default value is the ID of the instance's default endpoint. Currently only supports passing the instance default endpoint ID.

Response parameter

Parameter	Type	Example	Description
InstanceId	String	postgres-0af11cd4****	Instance ID.
DBEngineVersion	String	PostgreSQL_12	Compatible version. Values: 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	Number of parameters.
Parameters	Array of ParameterObject	Refer to the sample response.	Current running parameter list of this proxy.

ParameterObject

Parameter	Type	Example	Description
CheckingCode	String	[on\|off]	Parameter value range.
DefaultValue	String	off	Parameter default value. Refers to the default value provided in the default template corresponding to this instance.
Description	String	Use EXPLAIN ANALYZE for plan logging.	Parameter description in English.
DescriptionZH	String	Enable the sampling of EXPLAIN ANALYZE output.	Parameter description in Chinese.
ForceRestart	Boolean	false	Restart or not takes effect, values: true or false.
Name	String	auto_explain.log_analyze	Parameter name.
Type	String	bool	Parameter value type. Values: string, integer, real, bool, and enum.
Value	String	off	Parameter value. Refers specifically to the current instance running value.

Sample

Sample request

Sample response

RDS for PostgreSQL