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.
Constraints
- The new parameter values must be within the default ranges for specified DB engine versions. For details, see "Modifying Instance Parameters" in the Relational Database Service User Guide.
URI
- URI format
- 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
Name |
Mandatory |
Type |
Description |
---|---|---|---|
values |
Yes |
Map<String,String> |
Specifies the parameter values defined by users based on the default parameter templates.
|
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 Parameter description Name
Type
Description
job_id
String
Task ID.
restart_required
Boolean
Indicates whether a reboot is required.
- true: A reboot is required.
- false: A reboot is not required.
ignored_params
List
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.
- 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
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.