Modifying Parameters of a Specified DB Instance

Function

This API is used to modify parameters in the parameter template of a specified DB instance.

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

Constraints

• The values of the edited parameters must be within the default value range of the specified database version. For details about the range of parameter values, see "Modifying Parameters" in the Relational Database Service User Guide.

URI

• URI format

  PUT /v3/{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

Request example

• RDS for MySQL

  {
    "values" : { 
      "max_connections" : "10", 
      "autocommit" : "OFF",
      "binlog_checksum" : "CRC32",
      "innodb_purge_threads" : "4"
    } 
  }

• RDS for PostgreSQL

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

Response

• Normal response

  Table 3 Parameters

  Parameter	Type	Description
  job_id	String	Definition Task ID. Range N/A
  restart_required	Boolean	Definition Indicates whether a reboot is required. Range true: A reboot is required. false: A reboot is not required.
  ignored_params	List	Definition All parameters that are ignored and fail to be modified in the request parameter values. If a parameter does not exist, the modification will fail. The names of all ignored parameters are returned by ignored_params. Range N/A

• Example normal response

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

• 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.