Call the DescribeDBInstanceParameters API to query instance parameters.

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.

Request parameters

Parameter	Type	Required?	Example	Description
InstanceId	String	Yes	postgres-21a3333b****	Instance ID.
ParameterName	String	No	auto_explain.log_analyze	Parameter name. It supports fuzzy queries. tip When no value or an empty value is passed, all parameters under the specified instance will be queried.

Response parameter

Parameter	Type	Example	Description
InstanceId	String	postgres-21a3333b****	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	56	Number of parameters.
Parameters	Array of ParameterObject	Refer to the Sample response.	Current parameter configuration of the instance (kernel parameters).
NoneKernelParameters	Array of ParameterObject	Refer to the sample response.	Current parameter configuration of the instance (non-kernel parameters).

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	Is a restart required to take 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.

Example

Sample request

Sample response