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}
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02

**Table 1** Request parameters
Name	Type	Mandatory	Description
X-Auth-Token	String	Yes	User token obtained from IAM. For details, see Authentication.
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.

Requests

Parameter description

**Table 2** Parameter description
Name	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.

Example Request

Modifying a specified parameter template, including the name and the maximum number of connections to 10

{
  "description": "test",
  "parameter_values": 
    {
      "max_connections": "10"
    }
}

Responses

None

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.