文档中心

云数据库 PostgreSQL 版

参数管理

DescribeParameterTemplate

DescribeParameterTemplate

调用 DescribeParameterTemplate 接口查询参数模板详情。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
TemplateId	String	是	postgresql-4ad4ac5f712f****	参数模板的 ID。

返回参数

参数	类型	示例值	描述
TemplateInfo	Object of ParameterTemplateInfoObject	请参见返回示例。	参数模板的详细信息。

ParameterTemplateInfoObject

参数	类型	示例值	描述
AccountId	String	210006****	账户 ID。
CreateTime	String	2025-05-07T07:44:14.000Z	参数模板的创建时间。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
NeedRestart	Boolean	false	应用该参数模板是否需要重启实例（即该参数模板是否包含了需要重启实例才能生效的参数）。取值： true：不需要。 false：需要。
ParameterNum	Integer	1	该参数模板包含的参数个数。
TemplateCategory	String	DBEngine	参数模板的分类。当前取值仅能为 DBEngine。
TemplateDesc	String	这是一段参数模板的描述信息。	参数模板的描述信息。
TemplateId	String	postgresql-4ad4ac5f712f****	参数模板的 ID。
TemplateName	String	参数模板_测试	参数模板的名称。
TemplateParams	Array of ParameterObject	请参见返回示例。	参数模板的参数配置。
TemplateSource	String	User	参数模板的来源。当前取值仅能为 User。
TemplateType	String	PostgreSQL	参数模板的类型。当前取值仅能为 PostgreSQL。
TemplateTypeVersion	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。
UpdateTime	String	2025-05-07T08:15:02.000Z	最近一次修改参数模板的时间。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。说明如参数模板自创建后未被更新过，该字段则与 CreateTime 的值相同。

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:32

这个页面对您有帮助吗？

有用

有用

无用

无用