All Products
Search

This Product

    PolarDB:CreateParameterGroup

    Document Center

    PolarDB:CreateParameterGroup

    Last Updated:Nov 17, 2025

    Creates a PolarDB parameter template.

    Operation description

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:CreateParameterGroup

    create

    *All Resource

    *

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    RegionId

    string

    Yes

    The ID of the region where the parameter template is located.

    Note

    You can call the DescribeRegions operation to query region IDs.

    cn-hangzhou

    DBType

    string

    Yes

    The type of the database engine. Only MySQL is supported.

    MySQL

    DBVersion

    string

    Yes

    The version of the database engine. Valid values:

    • 5.6

    • 5.7

    • 8.0

    8.0

    ParameterGroupName

    string

    Yes

    The name of the parameter template. The name must meet the following requirements:

    • It must start with a letter and can contain letters, digits, and underscores (_). It cannot contain Chinese characters or end with an underscore (_).

    • It must be 8 to 64 characters in length.

    test_group

    ParameterGroupDesc

    string

    No

    The description of the parameter template. It must be 0 to 199 characters in length.

    test_group

    Parameters

    string

    Yes

    A JSON string that consists of parameters and their values. The values of the parameters must be strings. For example: {"wait_timeout":"86400","innodb_old_blocks_time":"1000"}.

    Note

    You can call the DescribeParameterTemplates operation to view the details of all parameters for a specific database engine version. The details include parameter names and value ranges.

    { "default_time_zone":"+8:00", "innodb_lock_wait_timeout":"50", "connect_timeout":"10", "xxx": "xxx" }

    ResourceGroupId

    string

    No

    The ID of the resource group.

    rg-**********

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    514D1D87-E243-4A5F-A87D-2785C3******

    ParameterGroupId

    string

    The ID of the parameter template.

    Note

    You can call the DescribeParameterGroups operation to query the list of parameter templates in a region, including their IDs.

    pcpg-**************

    Examples

    Success response

    JSON format

    {
  "RequestId": "514D1D87-E243-4A5F-A87D-2785C3******",
  "ParameterGroupId": "pcpg-**************"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    400

    InvalidRegionId.Malformed

    he specified parameter RegionId is not valid.

    400

    InvalidDBVersion.Malformed

    The Specified DBVersion is not valid.

    The specified DBVersion parameter is invalid.

    400

    InvalidParameterGroupName.Malformed

    The Specified parameter ParameterGroupName is not valid.

    The specified ParameterGroupName parameter is invalid.

    400

    NumberExceed.parameterGroupDesc

    The ParameterGroupDesc parameter`s number is exceed.

    The maximum number of ParameterGroupDesc values is reached.

    400

    InvalidEngine.Unsupported

    The specified Engine does not support this feature.

    This feature is not supported by the specified engine.

    400

    ParamGroupsNameInvalid

    The Specified parameter ParameterGroupName is not valid.

    The specified ParameterGroupName parameter is invalid.

    404

    InvalidDBType.NotFound

    The Specified DBType does not found.

    The specified DBType parameter does not exist.

    404

    InvalidUser.NotFound

    Specified user does not exist.

    The specified account does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.