Modifying a Parameter Template

Function

This API is used to modify a specified parameter template, including the name, description, and values of specified parameters in the parameter template.

• Before calling an API, you need to understand the API in Authentication.

Constraints

• This API is supported for MySQL and PostgreSQL databases.

• The modified parameter template name must be different from the name of an existing or a default parameter template. Default parameter templates cannot be modified.
• The values of the edited parameters must be within the default value range of the specified database version. For details about the range of parameter values, see "Modifying Parameters in a Parameter Template" in the Relational Database Service User Guide.
• The parameter values to be changed cannot be left blank at the same time.

URI

• URI format

  PUT /v3/{project_id}/configurations/{config_id}

• Example

  https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
  config_id	Yes	Specifies the parameter template ID.

Request

• Parameter description
  

  At least one parameter in the request body must be specified. Otherwise, the request fails to be delivered.

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  name	No	String	Specifies the parameter template name. It contains a maximum of 64 characters and can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).
  description	No	String	Specifies the parameter template description. It contains a maximum of 256 characters and does not support the following special characters: !<>='&" Its value is left blank by default.
  values	No	Map<String,String>	Specifies the parameter values defined by users based on the default parameter templates. If this parameter is not specified, no parameter value is to be changed. key: parameter name. For example, in "max_connections": "10", the key is max_connections. If key is left blank, the parameter value is not to be changed. If key is not empty, the parameter value cannot be empty, either. value: parameter value. For example, in "max_connections": "10", the value is 10.

• Request example

  { 
      "name": "configuration_test", 
      "description": "configuration_test", 
      "values": { 
         "max_connections": "10", 
         "autocommit": "OFF" 
      } 
  }

Response

• Normal response

  None

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.