文档中心

云数据库 veDB MySQL 版

参数管理

DescribeParameterTemplates - 查询参数模板列表

DescribeParameterTemplates - 查询参数模板列表

调用 DescribeParameterTemplates 接口查询参数模板列表。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
TemplateName	String	否	template_test	参数模板名称。
TemplateId	String	否	vedbmpt-5j37992t****	参数模板 ID。
TemplateCategory	String	否	DBEngine	参数模板分类，默认值为 DBEngine。
TemplateType	String	否	MySQL	参数模板的数据库类型，默认值为 MySQL。
TemplateTypeVersion	String	否	MySQL_8_0	参数模板适用的数据库引擎版本，取值范围： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。
TemplateSource	String	否	User	参数模板的类型。取值： User：用户模板。 System：系统模板。
PageSize	Integer	是	10	每页记录数。取值范围 1~1000，默认值为 10。
PageNumber	Integer	是	1	页码，取值大于等于 1，且不超过 Integer 的最大值，默认值为 1。

返回参数

参数	类型	示例值	描述
Total	Integer	1	查询返回总数。
TemplateInfos	Array of TemplateInfoObject	请参见返回示例。	参数模板详情信息。

TemplateInfoObject

参数	类型	示例值	描述
TemplateId	String	vedbmpt-5j37992t****	参数模板 ID。
TemplateName	String	template_test	参数模板名称。
TemplateCategory	String	DBEngine	参数模板分类，默认值为 DBEngine。
TemplateDescription	String	描述	参数模板描述，描述内容长度为 0~200 个字符。
TemplateTypeVersion	String	MySQL_8_0	参数模板适用的数据库引擎版本，取值范围： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。
TemplateSource	String	User	参数模板的类型。取值： System：系统模板。 User：用户模板。
ParameterNumber	Integer	6	参数模板包含的参数数量。
NeedRestart	Boolean	true	参数模板中是否包含需要重启实例生效的参数。
CreateTime	String	2022-10-10 10:10:37	参数模板创建时间。
UpdateTime	String	2022-10-10 10:10:37	参数模板修改时间。
TemplateType	String	MySQL	参数模板的数据库类型，默认值为 MySQL。

示例

请求示例

返回示例

错误码

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

最近更新时间：2026.02.25 13:20:57

这个页面对您有帮助吗？

有用

有用

无用

无用