Description

You can modify instance parameters. After submitting a request, RDS assigns a task, and the new parameter is applied to the instance. If any submitted parameter requires that the database be restarted, RDS restarts the database. Instances must meet the following conditions:

  • The current instance is running.
  • The current instance lock mode is normal.

There are three types of parameter values:

  • [1-65535]: indicates a numerical range. Regular identification is used to extract the minimum and maximum values. Then, the input parameter is verified based on the minimum and maximum values. In addition, the parameter must be a multiple of a divisible factor.
  • [utf8|gbk|latin1]: indicates a set value determination rule. Regular identification is used to extract the fixed value. Then, the parameter is verified based on these fixed values.
  • Others: conforms to regular expressions.

Before the task is assigned, RDS checks the parameter as follows:

  • Whether the parameter exist.
  • Whether the parameter can be modified.
  • Whether the parameter is valid.

If the parameter is invalid, RDS returns Error Code 400 and the information about the invalid parameter. For example:

{"HttpStatusCode":400,"Code":"InvalidParameter.Format",
"Message":"Specified parameter is not valid.[auto_increment_increment:a,character_set_client:41]"}

Request parameters

Name Type Required or not Description
Action String Yes required parameter. Value: ModifyParameter.
DBInstanceId String Yes Instance ID
Parameters String Yes JSON string for the parameter and its value. The parameter value must be string-type, for example, {“auto_increment_increment”:”1”, “character_set_client”:”utf8”}.
Forcerestart String No
  • True: Forcible restart . (True must be set when a parameter among parameters to be modified needs to be restarted. Otherwise, the modification is invalid).
  • False: Optional restart. Forcible restart is disabled by default.

Return parameters

Name Type Description
<Public Return Parameters> For more information, see Public parameters.

Request example

https://rds.aliyuncs.com/?Action=ModifyParameter
&DBInstanceId=riauvjz6zajfiq6ba1370329449201L
&Parameters={"auto_increment":"1","character_set_client":"gbk"}
&<Public Request Parameters>

Response example

XML format:

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

JSON format:

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