Modifying Parameters of a Specified Instance

Function

This API is used to modify parameters of a specified instance.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about request header parameters.

Constraints

• The following DB engines are supported: MySQL, PostgreSQL, and Microsoft SQL Server.

• The new parameter values must be within the default ranges for specified DB engine versions. For details, see Modifying Parameters of an RDS for MySQL Instance in Relational Database Service User Guide.
• Modifying sensitive parameters, for example, lower_case_table_names, is risky. For details, see "Suggestions on RDS for MySQL Parameter Tuning" in Relational Database Service User Guide.

URI

• URI format

  PUT https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/configurations

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
  instance_id	Yes	Definition Instance ID. Constraints N/A Range N/A Default Value N/A

Request

Example Request

• Change parameter values of an RDS for MySQL instance.

  PUT https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations
  
  {
    "values" : { 
      "div_precision_increment": "6",
      "connect_timeout": "20",
      "binlog_checksum" : "CRC32",
      "innodb_purge_threads" : "4"
    } 
  }

• Change parameter values of an RDS for PostgreSQL instance.

  {
    "values" : { 
      "autovacuum" : "on",
      "bytea_output" : "escape",
      "client_encoding" : "UTF8",
      "cpu_tuple_cost" : "0.01"
    } 
  }

• Change parameter values of an RDS for SQL Server instance.

  {
     "values":{
       "max server memory (MB)":"26317",
       "max degree of parallelism":"4"
     }
  }

Response

• Normal response

  Table 3 Parameters

  Parameter	Type	Description
  job_id	String	Definition Job ID. Range N/A
  restart_required	Boolean	Definition Whether a reboot is required. Range true: A reboot is required. false: A reboot is not required.

• Example normal response

  { 
    "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94",
    "restart_required" : false
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.