Modifying Parameters of a Specified DB Instance
Function
This API is used to modify parameters in the parameter template of a specified DB instance.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
rds:instance:updateParameter
write
instance
g:EnterpriseProjectId
g:ResourceTag/<tag-key>
rds:param:modify
-
URI
- URI format
PUT /v3.1/{project_id}/instances/{instance_id}/configurations
- Parameter description
Table 1 Parameters Parameter
Mandatory
Type
Description
project_id
Yes
String
Definition
Project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
Constraints
N/A
Range
N/A
Default Value
N/A
instance_id
Yes
String
Definition
Instance ID.
Constraints
N/A
Range
N/A
Default Value
N/A
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
values |
Yes |
Map<String,String> |
Definition Parameter values defined by users based on a default parameter template. Constraints N/A Range
Default Value N/A |
Example Request
https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations
{
"values" : {
"max_connections" : "10",
"autocommit" : "OFF",
"binlog_checksum" : "CRC32",
"innodb_purge_threads" : "4"
}
}
Response
- Normal response
Table 3 Parameters Parameter
Type
Description
job_id
String
Definition
Task 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.
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
- Abnormal
For details, see Status Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot