Modify the database parameter list

Last Updated: Sep 19, 2017

Description

You can modify instance parameters. After submitting a request, the RDS will assign a task and the new parameter will be applied to the instance. If any submitted parameter requires that the database be restarted, the RDS will restart the database. Instances must meet the following conditions, or the call may fail:

  • The current instance status is Running.

  • The current instance lock mode is Normal.

There are 3 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], which 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. A regular expression should apply.

Before the task is assigned, the RDS will check the parameter as follows:

  • Whether the parameter exist.

  • Whether the parameter can be modified.

  • Whether the parameter is valid.

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

  1. ```xml
  2. {"HttpStatusCode":400,"Code":"InvalidParameter.Format",
  3. "Message":"Specified parameter is not valid.[auto_increment_increment:a,character_set_client:41]"}
  4. ```

Request parameters

Name Type Required? 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.
{“auto_increment_increment”:”1”,
“character_set_client”:”utf8”}.
Forcerestart String No true: force restart (true must be input when a parameter among parameters to be modified needs to be restarted; otherwise, the modification is invalid). False: force restart disabled. The force restart is disabled by default.

Return parameters

Name Type Description
<Public Return Parameters> None For details, see Public parameters.

Example

  • Request example

    1. https://rds.aliyuncs.com/?Action=ModifyeParameter
    2. &DBInstanceId=riauvjz6zajfiq6ba1370329449201L
    3. &Parameters={"key_buffer_size":"456","character_set_client":"gbk"}
    4. &<Public Request Parameters>
  • Return example

    XML format:

    1. <ModifyeParameterResponse>
    2. <RequestId>542BB8D6-4268-45CC-A557-B03EFD7AB30A</RequestId>
    3. </ModifyeParameterResponse>

    JSON format:

    1. {
    2. "RequestId":"542BB8D6-4268-45CC-A557-B03EFD7AB30A",
    3. }
Thank you! We've received your feedback.