All Products
Search

This Product

    PolarDB:DescribeParameterGroup

    Document Center

    PolarDB:DescribeParameterGroup

    Last Updated:Apr 18, 2026

    Retrieves the details of a specified parameter template.

    Operation description

    Parameter templates let you centrally manage parameters for multiple clusters. You can quickly apply a parameter template to PolarDB clusters. For more information, see Use parameter templates.

    Note

    This feature currently supports only PolarDB for MySQL clusters.

    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:DescribeParameterGroup

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID.

    Note

    You can call the DescribeRegions operation to query all available regions and their IDs in your account.

    cn-hangzhou
    DBType

    string

    No

    The database engine type. Valid values:

    • MySQL

    • PostgreSQL

    • Oracle

    MySQL
    ParameterGroupId

    string

    Yes

    The ID of the parameter group.

    Note

    You can call the DescribeParameterGroups operation to query the details of all parameter groups in the specified region.

    pcpg-**************
    ResourceGroupId

    string

    No

    The ID of the resource group.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    RequestId

    string

    The request ID.

    F1F16757-D31B-49CA-9BF4-305BAF******
    ParameterGroup

    array<object>

    A list of parameter templates.

    array<object>

    ParameterDetail

    array<object>

    A list of parameters.

    object

    ParamValue

    string

    The parameter value.

    3000
    ParamName

    string

    The parameter name.

    back_log
    DBVersion

    string

    The database engine version.

    8.0
    ParameterGroupId

    string

    The ID of the parameter template.

    pcpg-**************
    ParameterGroupName

    string

    The name of the parameter template.

    test
    ForceRestart

    string

    Specifies whether a cluster restart is required for the parameter template to take effect. Valid values:

    • 0: No restart is required.

    • 1: A restart is required.

    1
    ParameterGroupType

    string

    The type of the parameter template. Valid values:

    • 0: default template

    • 1: custom template

    • 2: automatic backup template. This type of template is an automatic backup of the previous settings, created when you apply a new template.

    1
    ParameterGroupDesc

    string

    The description of the parameter template.

    testgroup
    CreateTime

    string

    The creation time of the parameter template, in yyyy-MM-ddTHH:mm:ssZ format (UTC).

    2023-03-10T08:40:39Z
    ParameterCounts

    integer

    The number of parameters in the parameter template.

    2
    DBType

    string

    The database engine type.

    MySQL

    Examples

    Success response

    JSON format

    {
  "RequestId": "F1F16757-D31B-49CA-9BF4-305BAF******",
  "ParameterGroup": [
    {
      "ParameterDetail": [
        {
          "ParamValue": "3000",
          "ParamName": "back_log"
        }
      ],
      "DBVersion": "8.0",
      "ParameterGroupId": "pcpg-**************",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterCounts": 2,
      "DBType": "MySQL"
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidRegionId.Malformed The specified parameter RegionId is not valid. The specified RegionId parameter is invalid.
    400 InvalidParameterGroupId.Malformed The Specified parameter ParameterGroupId is not valid. The specified ParameterGroupId parameter is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.