You can call this operation to modify the parameters of an instance.

When you call this operation, the instance must be in the running state.

You can view the modifiable parameters in the console. For more information, see Set parameters through the RDS console.

After you submit the request, RDS assigns a task to apply the modified parameters to the instance. If any of these parameters requires a database restart, RDS will restart the database.

Before assigning the task, RDS checks the parameters as follows:

  • Do the parameters exist?
  • Can the parameters be modified?
  • Are the parameters valid?

Debugging

You can use OpenAPI Explorer to perform debugging. OpenAPI Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required? Example Description
Action String Yes ModifyParameter

The operation that you want to perform. Set this parameter to ModifyParameter.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

Parameters String Yes {"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}

The JSON strings of parameters and their values. All the parameter values are of the string type. Format: {"parameter name 1": "parameter value1", "parameter name 2": "parameter value 2"...}.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxxxxx

The client token that is used to guarantee the idempotency of requests. The client token is generated by the client and is unique among different requests. It is a string of up to 64 ASCII characters.

Forcerestart Boolean No false

Indicates whether modified parameters take effect only after a database restart. Valid values:

  • true: force restart enabled. (If a modified parameter takes effect only after a database restart, the Forcerestart parameter must be set to true. Otherwise, the parameter modification does not take effect.)
  • false: force restart disabled.

Default value: false.

AccessKeyId String No LTAIfCxxxxxxx

The AccessKey ID issued by Alibaba Cloud for users to access services.

Response parameters

Parameter Type Example Description
RequestId String 542BB8D6-4268-45CC-A557-B03EFD7AB30A

The ID of the request.

Examples

Sample requests


http(s)://rds.aliyuncs.com/? Action=ModifyParameter
&DBInstanceId=rm-uf6wjk5xxxxxxx 
&Parameters={"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
&<Common request parameters>

Successful response examples

XML format

<ModifyeParameterResponse>
  <RequestId>542BB8D6-4268-45CC-A557-B03EFD7AB30A</RequestId>
</ModifyeParameterResponse>

JSON format

{
	"RequestId":"542BB8D6-4268-45CC-A557-B03EFD7AB30A"
}

Error codes

For a list of error codes, visit the API Error Center.