All Products
Search

This Product

    PolarDB:DescribeParameterGroup

    Document Center

    PolarDB:DescribeParameterGroup

    Last Updated:Dec 11, 2025

    Queries the details of a parameter template.

    Operation description

    Parameter templates allow you to manage cluster parameters in batches. You can then quickly apply a parameter template to a PolarDB cluster. For more information, see Use parameter templates.

    Note

    This feature is available only for 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 ID of the region.

    Note

    Call the DescribeRegions operation to query information about all available regions for your account, including region IDs.

    cn-hangzhou
    DBType

    string

    No

    ParameterGroupId

    string

    Yes

    The ID of the parameter template.

    Note

    Call the DescribeParameterGroups operation to query the details of all parameter templates in the destination region, including the parameter template IDs.

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

    string

    No

    The ID of the resource group.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

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

    array<object>

    The list of parameter template details.

    array<object>

    ParameterDetail

    array<object>

    The list of parameters.

    object

    ParamValue

    string

    The value of the parameter.

    3000
    ParamName

    string

    The name of the parameter.

    back_log
    DBVersion

    string

    The version of the database engine.

    8.0
    ParameterGroupId

    string

    The ID of the parameter template.

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

    string

    The name of the parameter template.

    test
    ForceRestart

    string

    Indicates whether the cluster must be restarted for the parameter template to take effect. Valid values:

    • 0: A restart is not 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. After you apply a new template, the system automatically backs up the previous parameter settings as a template.

    1
    ParameterGroupDesc

    string

    The description of the parameter template.

    testgroup
    CreateTime

    string

    The time when the parameter template was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

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

    integer

    The number of parameters in the parameter template.

    2
    DBType

    string

    The type of the database engine.

    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.