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

文档中心

立即注册

导航

ModifyDBInstanceParameters

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

调用 ModifyDBInstanceParameters 接口修改实例参数。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

前提条件

实例目前没有待执行的修改参数事件，可在计划内事件列表通过实例 ID 搜索查看，操作步骤请参见查看事件列表。

请求参数

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

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-gzwdsf9b****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
Parameters	Array of OverrideParameterObject	是	请参见请求示例。	需要修改的参数和参数值。关于 Parameters 的详细信息，请参见 OverrideParameterObject。
ScheduleType	String	否	Immediate	执行方式，取值： `Immediate`：立即执行（默认）。 `MaintainTime`：可维护时间段执行。说明可维护时间段在华北2（北京）、华东2（上海）地域为邀测功能，如需使用，请提交工单联系技术支持。关于可维护时间窗口的详情请参见设置可维护时间段。

InstanceId

String

是

vedbm-gzwdsf9b****

实例 ID。

说明

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

Parameters

Array of OverrideParameterObject

是

请参见请求示例。

需要修改的参数和参数值。关于 Parameters 的详细信息，请参见 OverrideParameterObject。

ScheduleType

String

否

Immediate

执行方式，取值：

Immediate：立即执行（默认）。
MaintainTime：可维护时间段执行。

说明

可维护时间段在华北2（北京）、华东2（上海） 地域为邀测功能，如需使用，请提交工单联系技术支持。关于可维护时间窗口的详情请参见设置可维护时间段。

返回参数

说明

请求参数 ScheduleType 的取值不同，则返回不同。

（默认）若选择立即执行，则返回 null。
若选择在可维护时间段内执行，则返回 ScheduleEventId 参数。

名称	类型	示例值	描述
ScheduleEventId	String	wpck1hqmndmb****	事件 ID。

请求示例

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

{
    "InstanceId": "vedbm-gzwdsf9b****",
    "Parameters": [
        {
            "ParameterName": "auto_increment_increment",
            "ParameterValue": "2"
        }
    ]
}

返回示例

立即执行。

{
    "ResponseMetadata": {
        "RequestId": "202502251546052135B1F0689AE7184178-7a8a42",
        "Action": "ModifyDBInstanceParameters",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": null
}

在可维护时间段内执行。

{
    "ResponseMetadata": {
        "RequestId": "20250225162129C9644D6550D2EE09F421-8b0794",
        "Action": "ModifyDBInstanceParameters",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "ScheduleEventId": "wpck1hqmndmb****"
    }
}

错误码

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