All Products
Search

This Product

    ApsaraDB RDS:CreateParameterGroup

    Document Center

    ApsaraDB RDS:CreateParameterGroup

    Last Updated:Apr 17, 2024

    Creates a parameter template for an instance.

    Operation description

    Supported database engines

    • MySQL
    • PostgreSQL

    References

    Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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 Resources is 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:CreateParameterGroupWRITE
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    		cn-hangzhou
    ParameterGroupNamestringYes

    The name of the parameter template.

    • The value must start with a letter and can contain letters, digits, periods (.), and underscores (_).
    • The value can be 8 to 64 characters in length.
    		test1234
    EnginestringYes

    The database engine. Valid values:

    • mysql
    • PostgreSQL
    		mysql
    EngineVersionstringYes

    The database engine version of the instance.

    • If the instance runs MySQL, the instance must run one of the following MySQL versions:

      • 5.6
      • 5.7
      • 8.0

    • If the instance runs PostgreSQL, the instance must run one of the following PostgreSQL versions:

      • 10.0
      • 11.0
      • 12.0
      • 13.0
      • 14.0
      • 15.0
    		5.7
    ParametersstringYes

    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"}
    ParameterGroupDescstringNo

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

    		test
    ResourceGroupIdstringNo

    The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the resource group ID.

    		rg-acfmy*****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    ParameterGroupIdstring

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

    		rpg-q488w14xvsk****
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

    {
  "ParameterGroupId": "rpg-q488w14xvsk****",
  "RequestId": "7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameters.MalformedThe specified parameter "Parameters" is not valid.The value of the Parameters parameter is invalid. Specify a valid value.
    400ParamGroupsNameInvalidThe 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.
    400InvalidEngine.MalformedSpecified engine is not valid.The database engine is invalid. Specify a valid database engine.
    400InvalidEngineVersion.MalformedSpecified engine version is not valid.The database engine version is invalid. Check the database engine version and try again.
    400ParamGroupsDbTypeNotSupportThe parameter group does not support the specified database type.The parameter template is supported only for RDS instances that run MySQL.
    400ParamGroupsDbVersionNotSupportThe 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.
    400ParamNotExistThis param Not ExistThe parameter does not exist. Check parameter configurations.
    400ParamTypeErrorThe parameter type error.The parameter type is invalid.
    400ParamGroupsNotExistOrTypeNotSupportThe parameter group does not exist or its type is not supported.The paramGroups does not exist or its type is not supported.
    400InvalidRegion.FormatSpecified Region is not valid.The region ID is invalid. Check the region ID.
    400%sThe following parameters are prohibited: <br />%s-
    400ParamGroupsDescInvalidThe maximum length of parameter group description is exceeded.The description of the parameter template can be up to 200 characters in length.
    400InvalidParameterValue.NotStandardInvalid parameter format.The value of the parameter is invalid.
    400InvalidParameters.FormatSpecified parameter is not validThe operation failed. The values of some parameters are invalid.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-07-25The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ResourceGroupId
    2023-05-09The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-03-01The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2022-10-28The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2022-06-23API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400