Updated on 2026-08-31 GMT+08:00

Updating a Custom Parameter Template

Function

This API is used to update a custom parameter template by synchronizing the parameter values from the default parameter template, including the specification parameter values. Before calling this API:

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

Calling Method

For details, see Calling APIs.

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 Permissions and Supported Actions for details on the required permissions.

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

Dependency

gaussdbformysql:param:update

Write

-

-

gaussdb:param:modify

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
gaussdbformysql:param:update	Write	-	-	gaussdb:param:modify	-

URI

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

**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, which uniquely identifies the parameter template. To obtain this value, see Querying Parameter Templates. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. 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
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value application/json
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us: English zh-cn: Chinese Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
parameters	No	Array of strings	Definition List of differential parameters to be updated. If a parameter has a value, update it to the value in the default template. If a parameter is left empty or not passed, retain the original value in the custom template. Constraints N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
name	String	Definition Parameter template name. Range N/A
diff_parameters	Array of GroupParameterDiffInfo objects	Definition List of differential parameters.
skipped_parameter_names	Array of strings	Definition List of parameters that are skipped during the update (the original value is the same as the target value).

**Table 5** GroupParameterDiffInfo
Parameter	Type	Description
name	String	Definition Parameter name. Range N/A
source_value	String	Definition Source parameter value (value in the current template). Range N/A
target_value	String	Definition Target parameter value (value in the default template). Range N/A

Status code: 400

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

Status code: 500

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

Example Request

Updating a custom parameter template

PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/configurations/61a4ea66210545909d74a05c27a7179fin07/upgrade

{
  "parameters" : [ "max_connections", "innodb_buffer_pool_size" ]
}

Example Response

Status code: 200

Success.

{
  "name" : "paramTemplate-test",
  "diff_parameters" : [ {
    "name" : "max_connections",
    "source_value" : "100",
    "target_value" : "200"
  } ],
  "skipped_parameter_names" : [ "innodb_buffer_pool_size" ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Parameter Template Management