云数据库 MySQL 版
云数据库 MySQL 版
云数据库 MySQL 版
文档指南
请输入
产品动态
内核功能
功能
用户指南
实例管理
连接管理
管理连接终端
备份恢复
服务可用性
日志管理
数据安全管理
参数管理
跨地域备份管理
API 参考
V2（2022-01-01）
实例管理
连接管理
账号管理
数据库管理
安全加密
备份与恢复
参数管理
资源包管理
附录
开发者工具
最佳实践
相关协议
- 文档首页
云数据库 MySQL 版API 参考V2（2022-01-01）参数管理DescribeParameterTemplate - 查询指定的参数模板详情
复制全文
下载 pdfDescribeParameterTemplate - 查询指定的参数模板详情
文档反馈
问问助手调用 DescribeParameterTemplate 接口查询指定的参数模板详情。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
TemplateId | String | 是 | mysql-sys-80bb93aa14be**** | 参数模板 ID。 |
ProjectName | String | 否 | default | 所属的项目。 说明 如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
TemplateInfo | 请参见返回示例。 | 参数模板列表。 |
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 | [ { "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 | 参数模板的类型。取值：
|
TemplateType | String | Mysql | 参数模板的数据库类型，默认值为 Mysql。 |
TemplateTypeVersion | String | MySQL_5_7 | 参数模板数据库版本，取值范围：
|
UpdateTime | String | 2022-10-10 10:10:37 | 模板的修改时间。 |
EngineType | String | 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 | 参数的期望值。 |
示例
请求示例
POST /?Action=DescribeParameterTemplate&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"TemplateId": "mysql-a3ba0f1eee19****"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230809193449E3FDCA6F98F2188DCD5D",
"Action": "DescribeParameterTemplate",
"Version": "2022-01-01",
"Service": "rds_mysql",
"Region": "cn-beijing"
},
"Result": {
"TemplateInfo": {
"AccountId": "2100000746",
"CreateTime": "2023-08-09 19:23:30",
"NeedRestart": false,
"ParameterNum": 2,
"ProjectName": "default",
"TemplateCategory": "DBEngine",
"TemplateDesc": "这是一段描述",
"TemplateId": "mysql-a3ba0f1e****",
"TemplateName": "test1234",
"TemplateParams": [
{
"Name": "auto_increment_increment",
"RunningValue": "2"
},
{
"Name": "auto_increment_offset",
"RunningValue": "3"
}
],
"TemplateSource": "User",
"TemplateType": "MySQL",
"TemplateTypeVersion": "MySQL_5_7",
"UpdateTime": "2023-08-09 19:28:32"
}
}
}
错误码
最近更新时间：2026.04.09 11:58:29
这个页面对您有帮助吗？
有用
有用
无用
无用