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

文档中心

立即注册

导航

SaveAsParameterTemplate

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

调用 SaveAsParameterTemplate 接口将目标实例的参数配置保存为参数模板。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-gzwdsf9b****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
TemplateName	String	是	template_test	参数模板名称。规则如下：只能包含中文、字母、数字、下划线（_）或中划线（-）。长度为 8~64 个字符。不能以数字、中划线（-）或下划线（_）开头。
TemplateDescription	String	否	描述	参数模板描述，描述内容长度为 0~200 个字符。

名称

类型

是否必选

示例值

描述

InstanceId

String

是

vedbm-gzwdsf9b****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询实例 ID。

TemplateName

String

是

template_test

参数模板名称。规则如下：

只能包含中文、字母、数字、下划线（_）或中划线（-）。
长度为 8~64 个字符。
不能以数字、中划线（-）或下划线（_）开头。

TemplateDescription

String

否

描述

参数模板描述，描述内容长度为 0~200 个字符。

返回参数

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

请求示例

POST /?Action=SaveAsParameterTemplate&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": "Test-template",
    "TemplateDescription": "描述",
    "InstanceId": "vedbm-gzwdsf9b****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202502281142015025241BA9FFBBEFBC25-423411",
        "Action": "SaveAsParameterTemplate",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "TemplateId": "vedbmpt-t5vq7ckt****"
    }
}

错误码

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