You need to enable JavaScript to run this app.
RDS for MySQL

RDS for MySQL

  • Documentation
    • RDS for MySQLAPI referenceV2（2022-01-01）Managing parametersModifyDBInstanceParameters
Copy page
Download PDF
Managing parameters
ModifyDBInstanceParameters
Copy page
Download PDF
ModifyDBInstanceParameters

Call the ModifyDBInstanceParameters API to modify instance parameters.

Request type

Asynchronous request.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
mysql-h441603c****
Instance ID.
Parameters
Object[]
Yes
None
A parameter value object containing custom parameter values defined by the user based on the default parameter template.
ParameterName
String
No
auto_increment_increment
Parameter name.
ParameterValue
String
No
1
Parameter value. Specifically refers to the current instance running value.
ParamApplyScope
String
No
AllNode

Specify the application scope for parameter modification. Valid values:

  • AllNode: All nodes. Default value.
  • OnlyMasterSlaveNode: Only primary and secondary nodes.
  • OnlyReadOnlyNode: All read-only nodes.
  • CustomNode: Specified read-only nodes.

tip

This parameter takes effect only when the instance type is dual-node.

CustomNodeIds
String[]
No
["mysql-c7a79d83****-r417e"]

The ID of the read-only node to which the parameter modification needs to be applied.

tip

This parameter takes effect only when the ParamApplyScope parameter is set to CustomNode.

TemplateId
String
No
mysql-411668b4ab18****

The ID of the parameter template to use when modifying the parameters of an instance through the parameter template.

tip

  • You need to use a parameter template that matches the engine version of the instance.
  • If this field is provided, the parameter settings in the parameter template specified by this field will prevail, and the parameter settings in the Parameters field will be ignored. When modifying the parameters of an instance through a parameter template, you can pass an empty array for the Parameters field.

Response parameters

null

Sample request 

POST /?Action=ModifyDBInstanceParameters&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****
{
    "InstanceId": "mysql-8baa525f****",
    "Parameters": [
        {
            "ParameterName": "auto_increment_increment",
            "ParameterValue": "1"
        }
    ]
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "20230111142239CD77A5FDFBB20E7FD96C",
        "Action": "ModifyDBInstanceParameters",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": null
}

Error codes

For more details, refer to Error codes.

Last updated: 2026.01.30 11:13:50