Creates a parameter template for an instance.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| rds:CreateParameterGroup | create |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the parameter template. You can call the DescribeRegions operation to query the most recent zone list. | cn-hangzhou |
| ParameterGroupName | string | Yes | The name of the parameter template.
| test1234 |
| Engine | string | Yes | The database engine. Valid values:
| mysql |
| EngineVersion | string | Yes | The database engine version of the instance.
| 5.7 |
| Parameters | string | Yes | 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 more information about the parameters that can be modified, see Modify the parameters of an ApsaraDB RDS for MySQL instance or Modify the parameters of an ApsaraDB RDS for PostgreSQL instance. | {"back_log":"3000","wait_timeout":"86400"} |
| ParameterGroupDesc | string | No | The description of the parameter template. The value can be up to 200 characters in length. | test |
| ResourceGroupId | string | No | The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the resource group ID. | rg-acfmy***** |
Response parameters
Examples
Sample success responses
JSONformat
{
"ParameterGroupId": "rpg-q488w14xvsk****",
"RequestId": "7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameters.Malformed | The specified parameter "Parameters" is not valid. | The value of the Parameters parameter is invalid. Specify a valid value. |
| 400 | ParamGroupsNameInvalid | The specified parameter group name is invalid. | The name of the parameter template is invalid. The name must be 8 to 64 characters in length and can contain letters, digits, decimal points (.), and underscores (_). The name must start with a letter. |
| 400 | InvalidEngine.Malformed | Specified engine is not valid. | The database engine is invalid. Specify a valid database engine. |
| 400 | InvalidEngineVersion.Malformed | Specified engine version is not valid. | The database engine version is invalid. Check the database engine version and try again. |
| 400 | ParamGroupsDbTypeNotSupport | The parameter group does not support the specified database type. | The parameter template is supported only for RDS instances that run MySQL. |
| 400 | ParamGroupsDbVersionNotSupport | The parameter group does not support the database version. | The parameter template is supported only for RDS instances that run MySQL 5.6, MySQL 5.7, or MySQL 8.0. |
| 400 | ParamNotExist | This param Not Exist | The parameter does not exist. Check parameter configurations. |
| 400 | ParamTypeError | The parameter type error. | The parameter type is invalid. |
| 400 | ParamGroupsNotExistOrTypeNotSupport | The parameter group does not exist or its type is not supported. | The paramGroups does not exist or its type is not supported. |
| 400 | InvalidRegion.Format | Specified Region is not valid. | The region ID is invalid. Check the region ID. |
| 400 | %s | The following parameters are prohibited: <br />%s | - |
| 400 | ParamGroupsDescInvalid | The maximum length of parameter group description is exceeded. | The description of the parameter template can be up to 200 characters in length. |
| 400 | InvalidParameterValue.NotStandard | Invalid parameter format. | The value of the parameter is invalid. |
| 400 | InvalidParameters.Format | Specified parameter is not valid | The operation failed. The values of some parameters are invalid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-07-25 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-05-09 | The Error code has changed | View Change Details |
| 2023-03-01 | The Error code has changed | View Change Details |
| 2022-10-28 | The Error code has changed | View Change Details |
| 2022-06-23 | API Description Update. The Error code has changed | View Change Details |