CreateParameterTemplate--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

CreateParameterTemplate

最近更新时间：2025.03.25 10:11:37首次发布时间：2025.03.25 10:11:37

调用 CreateParameterTemplate 接口创建参数模板。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
TemplateName	String	是	template_test	参数模板名称。规则如下：只能包含中文、字母、数字、下划线（_）或中划线（-）。长度为 8~64 个字符。不能以数字、中划线（-）或下划线（_）开头。
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 版本。
TemplateParameters	Array of OverrideParameterObject	是	请参见请求示例。	参数模板包含的参数和参数值信息。关于 TemplateParameters 的详细信息，请参见 OverrideParameterObject。
TemplateDescription	String	否	描述	参数模板描述，描述内容长度为 0~200 个字符。

返回参数

名称	类型	示例值	描述
TemplateId	String	vedbmpt-5j37992t****	参数模板 ID。

请求示例

POST /?Action=CreateParameterTemplate&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20250228T114308Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20250228/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
    "TemplateName": "template_test",
    "TemplateDescription": "描述",
    "TemplateTypeVersion": "MySQL_8_0",
    "TemplateCategory": "DBEngine",
    "TemplateType": "MySQL",
    "TemplateParameters": [
        {
            "ParameterName": "auto_increment_increment",
            "ParameterValue": "3"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025022810460355DE283555EBAEC99985-09cf2c",
        "Action": "CreateParameterTemplate",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "TemplateId": "vedbmpt-5j37992t****"
    }
}

错误码

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