You can call the CreateParameterGroup operation to create a parameter template.

You can configure a number of parameters at a time by using a parameter template and then apply the parameter template to an ApsaraDB RDS instance. For more information, see Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances.

Note Parameter templates are supported only for RDS instances that run MySQL.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateParameterGroup

The operation that you want to perform. Set the value to CreateParameterGroup.

RegionId String Yes cn-hangzhou

The region ID of the parameter template. You can call the DescribeRegions operation to query the most recent region list.

ParameterGroupName String Yes test1234

The name of the parameter template.

  • The name can contain letters, digits, periods (.), and underscores (_) and must start with a letter.
  • The name can be 8 to 64 characters in length.
Engine String Yes mysql

The database engine. Set the value to mysql.

EngineVersion String Yes 5.7

The database engine version that is run on the instance. Valid values:

  • 5.6
  • 5.7
  • 8.0
Parameters String Yes null

A JSON string that consists of parameters and their values in the parameter template. Format: {"Parameter 1":"Value of Parameter 1","Parameter 2":"Value of Parameter 2"...}. For information about configurable parameters, see Configure the parameters of an ApsaraDB RDS for MySQL instance.

ParameterGroupDesc String No test

The description of the parameter template. The description can be up to 200 characters in length.

Response parameters

Parameter Type Example Description
ParameterGroupId String rpg-q488w14xvsk3o6un

The ID of the parameter template. You can call the DescribeParameterGroups operation to query the IDs of parameter templates.

RequestId String 7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1

The ID of the request.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=CreateParameterGroup
&RegionId=cn-hangzhou
&ParameterGroupName=test1234
&Engine=mysql
&EngineVersion=5.7
&Parameters={"back_log":"3000","wait_timeout":"86400"}
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateParameterGroupResponse>
<RequestId>7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1</RequestId>
</CreateParameterGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1"
}

Error codes

HTTP status code Error code Error message Description
400 ParamGroupsNameInvalid The parameter group name is invalid. The error message returned because the name of the parameter template is invalid. The name must be 8 to 64 characters in length and can contain letters, digits, periods (.), and underscores (_). The name must start with a letter.
400 ParamGroupsNameInvalid The specified parameter group name is invalid. The error message returned because the name of the parameter template is invalid. The name must be 8 to 64 characters in length and can contain letters, digits, periods (.), and underscores (_). The name must start with a letter.

For a list of error codes, visit the API Error Center.