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

文档中心

立即注册

导航

ApplyParameterTemplate

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

调用 ApplyParameterTemplate 接口应用参数模板。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

名称	类型	是否必选	示例值	描述
InstanceIds	Array of String	是	["vedbm-d6rjf5ln****"]	实例 ID，多个实例 ID 之间使用英文逗号（,）分隔。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
TemplateId	String	是	vedbmpt-5j37992t****	参数模板 ID。说明您可以调用 DescribeParameterTemplates 接口查询参数模板 ID。
ScheduleType	String	否	Immediate	执行方式，取值： `Immediate`：立即执行（默认）。 `MaintainTime`：可维护时间段执行。说明可维护时间段为邀测功能，如需使用，请提交工单联系技术支持。更多详情请参见设置可维护时间段。

InstanceIds

Array of String

是

["vedbm-d6rjf5ln****"]

实例 ID，多个实例 ID 之间使用英文逗号（,）分隔。

说明

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

TemplateId

String

是

vedbmpt-5j37992t****

参数模板 ID。

说明

您可以调用 DescribeParameterTemplates 接口查询参数模板 ID。

ScheduleType

String

否

Immediate

执行方式，取值：

Immediate：立即执行（默认）。
MaintainTime：可维护时间段执行。
说明
可维护时间段为邀测功能，如需使用，请提交工单联系技术支持。更多详情请参见设置可维护时间段。

返回参数

null

请求示例

POST /?Action=ApplyParameterTemplate&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****

{
    "InstanceIds": [
        "vedbm-alsr7pdh****"
    ],
    "TemplateId": "vedbmpt-5j37992t****",
    "ScheduleType": "Immediate"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025022811402850D45C748D1373DA201D-371241",
        "Action": "ApplyParameterTemplate",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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