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.

• Before calling this API, obtain the required region and endpoint.

Constraints

• 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 the "Modifying Parameters in a Parameter Template" section 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 https://{Endpoint}/v3/{project_id}/configurations/{config_id}

• 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

  Important

  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	Object	Specifies the parameter values defined by users based on the default parameter template. If this parameter is left blank, the parameter value cannot be changed. For details, see Table 3.

  Table 3 values field data structure description

  Name	Mandatory	Type	Description
  key	No	String	Specifies the parameter name. For example, in "max_connections": "10", the key is max_connections. If key is not empty, the parameter value cannot be empty, either.
  value	No	String	Specifies the parameter value. For example, in "max_connections": "10", the value is 10.

• Example

  PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9

• 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.

last updated: 2024-05-18 01:11