You need to enable JavaScript to run this app.
文档中心
云数据库 MySQL 版

云数据库 MySQL 版

复制全文
下载 pdf
参数管理
CreateParameterTemplate - 创建参数模板
复制全文
下载 pdf
CreateParameterTemplate - 创建参数模板
调用 CreateParameterTemplate 接口创建参数模板。​
请求类型​
同步请求。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
TemplateName​
String​
是​
test​
参数模板名称。​
TemplateType​
String​
否​
Mysql​
参数模板的数据库类型,默认值为 Mysql。​
TemplateTypeVersion​
String​
否​
MySQL_5_7​
参数模板的数据库版本,取值范围:​
  • MySQL_5_7:默认值,MySQL 5.7 版本。​
  • MySQL_8_0:MySQL 8.0 版本。​
TemplateParams​
Array of InstanceParam​
是​
[​
{​
"Name": "auto_increment_increment",​
"RunningValue": "1"​
}​
]​
参数模板中所包含的参数。​
TemplateDesc​
String​
否​
test​
参数模板描述。​
ProjectName​
String​
否​
default​
所属的项目。​
说明​
如您调用接口使用的 AK/SK 属于某个子账号,且该子账号只拥有某个项目的权限,需要传入该请求参数。​
EngineType​
String​
否​
RocksDB​
数据库引擎类型。取值:​
  • InnoDB:InnoDB 引擎。​
  • RocksDB:RocksDB 引擎。​
说明​
作为请求参数时,默认值为 InnoDB。​
​
InstanceParam​
​
参数​
类型​
是否必选​
示例值​
描述​
Name​
String​
是​
auto_increment_increment​
实例参数名称。​
说明​
在 CreateParameterTemplate 和 ModifyParameterTemplate 做请求参数时,只需要传入 Name 和 RunningValue。​
RunningValue​
String​
是​
1​
参数模板中配置的数值或表达式。​
说明​
  • 调用 CreateParameterTemplate、ModifyParameterTemplate 时,该字段传入的是写入模板配置的数值或表达式。​
  • 调用 DescribeParameterTemplate 接口查询模板时,该字段返回的是模板中保存的配置值。​
  • 当模板被应用到具体实例后,若该值为表达式,系统会按目标节点的规格重新计算,因此实例上最终生效的运行值可能与模板中配置的值不同。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
TemplateId​
String​
mysql-a3ba0f1eee19****​
新创建的参数模板的 ID。​
​
示例​
请求示例​
​
POST /?Action=CreateParameterTemplate&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****​
{​
"TemplateName": "test123",​
"TemplateDesc": "描述",​
"TemplateTypeVersion": "MySQL_5_7",​
"TemplateType": "Mysql",​
"TemplateParams": [​
{​
"Name": "auto_increment_increment",​
"RunningValue": "2"​
}​
]​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230809192132F1F5C26E15FFA18CAAAB",​
"Action": "CreateParameterTemplate",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": {​
"TemplateId": "mysql-a3ba0f1eee19****"​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.10.16 15:31:05
这个页面对您有帮助吗?
有用
有用
无用
无用