doc-exports/docs/rds/api-ref/rds_09_0305.html

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 an API, you need to understand the API in Authentication.
• Before calling this API, obtain the required region and endpoint.

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 the "Modifying Parameters in a Parameter Template" section in the Relational Database Service User Guide.

URI

• URI format

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

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
  instance_id	Yes	Specifies the DB instance ID.

Request

• Parameter description

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  values	Yes	Object	Specifies the parameter values defined by users based on the default parameter templates. For details, see Table 3.

  Table 3 values field data structure description

  Name	Mandatory	Type	Description
  key	Yes	String	Specifies the parameter name. For example, in "max_connections": "10", the key is max_connections.
  value	Yes	String	Specifies the parameter value. For example, in "max_connections": "10", the value is 10.

• Example

  PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations

• Request example

  { 
      "values": { 
         "max_connections": "10", 
         "autocommit": "OFF" 
      }
  }

Response

• Normal response

  Table 4 Parameter description

  Name	Type	Description
  restart_required	Boolean	Indicates whether a reboot is required. true: A reboot is required. false: A reboot is not required.
  job_id	String	Job ID.
  ignored_params	Set<String>	List of ignored parameters. If a parameter does not exist or is read-only, the parameter cannot be modified and the names of all ignored parameters are returned by ignored_params.

• Example normal response

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

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

Parent topic: Parameter Configuration