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

**Table 1** URI parameters
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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. To obtain the value, call the API for obtaining a user token. After the request is processed, the value of X-Subject-Token in the message 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. Value range: en-us zh-cn

**Table 3** Request body parameters
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

**Table 4** Response body parameters
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. true: The instance needs to be rebooted. false: The instance does not need to be rebooted.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
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

Status Code	Description
200	Success.
400	Client error.
500	Server error.

Error Code

For details, see Error Codes.

Parent topic: Parameter Template Management

Previous topic: Obtaining Parameter Information of a Specified DB Instance

Next topic: Replicating the Parameter Template of a DB Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot