Updated on 2026-03-16 GMT+08:00

Modifying Parameters in a Parameter Template

Function

This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

Constraints

Default parameter templates cannot be modified.
The name of the modified parameter template must be different from that of a default parameter template.
The parameter values to be modified must be within the default value range of the specified database version.

URI

PUT /v3/{project_id}/configurations/{configuration_id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
configuration_id	Yes	String	Definition Parameter template ID. Constraints N/A Range To obtain this value, see Querying Parameter Templates. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition 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. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Definition Parameter template name. Constraints N/A Range The template name can contain 1 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.) are allowed. The parameter template description, parameter name, and parameter value mapping cannot be empty at the same time. Default Value N/A
description	No	String	Definition Parameter template description. Constraints N/A Range The description can consist of up to 256 characters. It cannot contain carriage returns or any of the following special characters: !<"='>& Default Value Empty
parameter_values	No	Map<String,String>	Definition 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. Constraints N/A

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
job_id	String	Definition ID of the task for modifying a parameter template. Range N/A

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 in a parameter template

PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr07
{
  "parameter_values" : {
    "max_user_connections" : "4"
  }
}

Example Response

Status code: 200

Success.

{
  "job_id" : "f6cb21fe-186a-4931-b20d-764ced1f1f6b"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Parameter Template Management