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

Modifying a Parameter Template

Description

This API is used to modify parameters in a specified parameter template, including the parameter names, descriptions, and values.

Restrictions

  • This API applies only to DDS Community Edition.
  • Default parameter templates cannot be modified.
  • The modified parameter template name must be different from the name of an existing or a default parameter template.
  • The parameter values to be modified must be within the default value range of the specified database version.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}

Table 1 Path parameters

Name

Type

Mandatory

Description

project_id

String

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

config_id

String

Yes

Parameter template ID.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token

Table 3 Parameter description

Parameter

Mandatory

Type

Description

name

No

String

The parameter template name.

It contains a maximum of 64 characters and can contain only letters, digits, hyphens (-), underscores (_), and periods (.). If this parameter is not transferred, the parameter template name is not changed.

The parameter template name, parameter template description, parameter name, and parameter value mapping cannot be all empty.

description

No

String

Parameter template description. It contains a maximum of 256 characters and does not support special characters !<>=&"' If this parameter is not transferred, the parameter template description is not changed.

parameter_values

No

Map<String,String>

Mapping between parameter names and parameter values. You can customize parameter values based on the parameters in the default parameter template.

  • Request example
    {
      "description": "test",
      "parameter_values": 
        {
          "max_connections": "10"
        }
    }

Response Parameters

None

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.