Modifying Parameters of a Specified DB Instance
Function
This API is used to modify parameters of a specified DB instance. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
PUT /v3/{project_id}/instances/{instance_id}/configurations
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
|
instance_id |
Yes |
String |
Instance ID, which is compliant with the UUID format. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. |
|
Content-Type |
Yes |
String |
Content type. Value: application/json |
|
X-Language |
No |
String |
Request language type. The default value is en-us. Values:
|
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
parameter_values |
Yes |
Map<String,String> |
Mapping between parameter names and parameter values. You can specify parameter values based on a default parameter template. If this parameter is not specified, the original parameter information is retained. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
job_id |
String |
Task ID for modifying the parameters of a specified DB instance. |
|
restart_required |
Boolean |
Whether the instance needs to be rebooted.
|
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Request
Modifying parameters of a specified DB instance
PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/3ef58db3986540d19f95151309368d34in07/configurations
{
"parameter_values" : {
"max_user_connections" : "100"
}
}
Example Response
Status code: 200
Success.
{
"job_id" : "e5d698a9-d8db-47d2-bf75-3c9018f72b6f",
"restart_required" : false
}
Status Code
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.
