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

RDS for MySQL

Copy page
Download PDF
Managing parameters
ModifyDBInstanceParameters
Copy page
Download PDF
ModifyDBInstanceParameters
Request type​
Asynchronous request.​
Precautions​
If the innodb_buffer_pool_size parameter is modified, the system verifies each node set in the ParamApplyScope parameter one by one to check whether its value meets the value range requirements. If verification fails for any node, this request is rejected synchronously, and no subsequent task is created.​
Debug​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
​
Parameter​
Type​
Is it required?​
Sample value​
Description​
InstanceId​
String​
Yes​
mysql-h441603c****​
Instance ID.​
Parameters​
Array of ParametersObject​
Yes​
Null​
Parameter value object. It is the parameter values customized by the user based on the default parameter template.​
TemplateId​
String​
No​
mysql-411668b4ab18****​
The ID of the parameter template used to modify the instance parameters.​
tip​
  • The parameter template must have the same engine version as the instance.​
  • If this field is specified, the parameter settings from the specified parameter template are used, and the settings in the Parameters field are ignored. To modify the parameters of the instance using a parameter template, you can pass an empty array for the Parameters field.​
ParamApplyScope​
String​
No​
AllNode​
Specifies the application scope of the parameter modification. Values:​
  • AllNode: all nodes. Default value.​
  • OnlyMasterSlaveNode: only the primary and secondary nodes.​
  • OnlyReadOnlyNode: all read-only nodes.​
  • CustomNode: the specified read-only node.​
tip​
  • This parameter applies only when the instance type is a double node.​
  • If this parameter is not specified, the default value is AllNode.​
  • When the value is OnlyReadOnlyNode or CustomNode, the instance must have read-only nodes.​
  • If the modified parameter needs to take effect on all nodes, this parameter value must be AllNode.​
CustomNodeIds​
Array of String​
No​
["mysql-c7a79d83****-r417e"]​
The ID of the read-only node to which the parameter modifications apply.​
tip​
  • This parameter takes effect only when the value of the ParamApplyScope parameter is CustomNode. This parameter must be non-empty at this time.​
  • The value must be a valid read-only node ID for the current instance.​
​
ParametersObject​
​
Parameter​
Type​
Is it required?​
Sample value​
Description​
ParameterName​
String​
No​
auto_increment_increment​
Parameter name.​
ParameterValue​
String​
No​
1​
Parameter value. The parameter value or expression to be set.​
​
Response parameter​
null​
Sample​
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​
Call the ModifyDBInstanceParameters API to modify instance parameters.​
​
{​
"ResponseMetadata": {​
"RequestId": "20230111142239CD77A5FDFBB20E7FD96C",​
"Action": "ModifyDBInstanceParameters",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": null​
}​
​
Error code​
For more details, refer to Error codes.​
Last updated: 2026.10.16 15:34:07