Adding Custom Parameters

Function

This API is used to add parameter information to a parameter template identified by a specified ID.

URI

• URI format

  PATH: /v1.0/{project_id}/configurations/{id}

  Method: PATCH

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region.
  id	Yes	Specifies the parameter template ID.

• Restrictions

  • Currently, the DB engines MySQL and PostgreSQL support modifying parameter templates.

  • The values of the newly added parameters must be within the default value range of the specified database version. For details about the range of parameter values, see section "Modifying Parameters in a Parameter Template" in the Relational Database Service User Guide.

  • Parameter template modifications will take effect for DB instances to which the parameter template applies. Some modifications take effect only after the DB instance reboots.

Request

• Parameter description

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  configuration	Yes	Dictionary data structure. For details, see Table 3.	Specifies the parameter template object.

  Table 3 configuration field data structure description

  Name	Mandatory	Type	Description
  values	No	Dictionary data structure. For details, see Table 4.	Specifies the parameter values defined by users based on the default parameter template.

  Table 4 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.
  value	No	String	Specifies the parameter value. For example, in "max_connections": "10", the value is 10.

• Request example

  {
    "configuration": {
      "values": {
         "max_connections": "10",
         "autocommit": "OFF"
      }
    }
  }
  

Normal Response

{
  "errCode": "RDS.0041",
  "externalMessage": "Operation successful."
}

Abnormal Response

For details, see Abnormal Request Results.

last updated: 2024-07-27 00:14