文档中心

云数据库 MySQL 版

参数管理

ListParameterTemplates - 查询例的参数模板列表

ListParameterTemplates - 查询例的参数模板列表

调用 ListParameterTemplates 接口查询 MySQL 实例的参数模板列表。

请求类型

同步请求。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
TemplateCategory	String	否	DBEngine	模板类别，取值为 DBEngine（数据库引擎参数）。
TemplateType	String	否	Mysql	参数模板的数据库类型，默认值为 Mysql。
TemplateTypeVersion	String	否	MySQL_5_7	参数模板的数据库版本，取值范围： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。
TemplateSource	String	否	System	参数模板来源，取值范围： System ：系统。 User：用户。
Limit	Integer	否	10	每页记录数。最小值为 1，最大值不超过 100。默认值为 10。
Offset	Integer	否	0	当前页查询偏移量，取值最小为 0。默认值为 0。
ProjectName	String	否	default	所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
TemplateName	String	否		模板名称
EngineType	String	否	RocksDB	数据库引擎类型。取值： InnoDB：InnoDB 引擎。 RocksDB：RocksDB 引擎。说明作为请求参数时，默认值为 InnoDB。

返回参数

参数	类型	示例值	描述
Total	Integer	10	参数模板总数。
TemplateInfos	Array of ParameterTemplateInfo	请参见返回示例。	参数模板列表。

ParameterTemplateInfo

参数	类型	示例值	描述
AccountId	String	0	账户 ID。
CreateTime	String	2023-11-19 19:23:22	创建时间（UTC+8 时间）。格式为 yyyy-MM-dd HH:mm:ss。
NeedRestart	Boolean	true	模板是否包含需要重启的参数。
ParameterNum	Long	100	模板包含的参数个数。
ProjectName	String	default	模板所属的项目。说明如参数模板为存量模板且尚未归属至具体项目，则返回为空。
TemplateCategory	String	DBEngine	模板类别，取值为 DBEngine（数据库引擎参数）。
TemplateDesc	String	MySQL 8.0 default parameter template	参数模板描述。
TemplateId	String	mysql-sys-80bb93aa14be****	参数模板 ID。
TemplateName	String	MySQL_8.0_Default	参数模板名称。
TemplateParams	Array of InstanceParam	[ { "DefaultValue": "1", "Description": "Auto-increment columns are incremented by this.", "ExpectValue": "", "Name": "auto_increment_increment", "Restart": false, "RunningValue": "1", "ValueRange": "[1-65535]" } ]	模板所包含的参数。
TemplateSource	String	System	参数模板的类型。取值： System：系统模板。 User：用户模板。
TemplateType	String	Mysql	参数模板的数据库类型，默认值为 Mysql。
TemplateTypeVersion	String	MySQL_5_7	参数模板数据库版本，取值范围： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。
UpdateTime	String	2022-10-10 10:10:37	模板的修改时间。
EngineType	String	RocksDB	数据库引擎类型。取值： InnoDB：InnoDB 引擎。 RocksDB：RocksDB 引擎。说明作为请求参数时，默认值为 InnoDB。

InstanceParam

参数	类型	示例值	描述
DefaultValue	String	1	参数的默认值。
Description	String	Auto-increment columns are incremented by this.	参数的描述信息。
Name	String	auto_increment_increment	实例参数名称。说明在 CreateParameterTemplate 和 ModifyParameterTemplate 做请求参数时，只需要传入 Name 和 RunningValue。
Restart	Boolean	false	是否需要重启实例以生效。
RunningValue	String	1	参数运行值。说明在 CreateParameterTemplate 和 ModifyParameterTemplate 做请求参数时，只需要传入 Name 和 RunningValue。
ValueRange	String	[1-65535]	参数的取值范围。
Expression	String		参数的表达式。
ExpectValue	String	3	参数的期望值。

示例

请求示例

返回示例

错误码

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

最近更新时间：2026.04.09 11:58:29

这个页面对您有帮助吗？

有用

有用

无用

无用