Queries the details of a specified parameter template in a specified region.

You can use parameter templates to manage multiple parameters at a time and quickly apply existing parameters to a PolarDB cluster.

Note Only PolarDB for MySQL clusters support this feature.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeParameterGroup

The operation that you want to perform. Set the value to DescribeParameterGroup.

ParameterGroupId String Yes pcpg-**************

The ID of the parameter template.

Note You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
RegionId String Yes cn-hangzhou

The ID of the region.

Note You can call the DescribeRegions operation to query all regions that are available within your account, such as the region ID.

Response parameters

Parameter Type Example Description
ParameterGroup Array of ParameterGroup

The details of parameter templates.

CreateTime String 2021-03-10T08:40:39Z

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

DBType String MySQL

The type of the database engine.

DBVersion String 8.0

The version of the database engine. Valid values:

ForceRestart String 1

Indicates whether to restart the cluster when this parameter template is applied. Valid values:

  • 0: A restart is not required.
  • 1: A restart is required.
ParameterCounts Integer 2

The number of parameters in the parameter template.

ParameterDetail Array of ParameterDetail

The details of parameters in the parameter template.

ParamName String back_log

The name of a parameter in the parameter template.

ParamValue String 3000

The value of a parameter in the parameter template.

ParameterGroupDesc String testgroup

The description of the parameter template.

ParameterGroupId String pcpg-**************

The ID of the parameter template.

ParameterGroupName String test

The name of the parameter template.

ParameterGroupType String 1

The type of the parameter template. Valid values:

  • 0: the default parameter template.
  • 1: a custom parameter template.
  • 2: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings of the cluster and saves the backup as a template.
RequestId String F1F16757-D31B-49CA-9BF4-305BAF******

The ID of the request.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeParameterGroup
&ParameterGroupId=pcpg-**************
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeParameterGroupResponse>
  <RequestId>F1F16757-D31B-49CA-9BF4-305BAF******</RequestId>
  <ParameterGroup>
        <ParameterDetail>
              <ParamValue>3000</ParamValue>
              <ParamName>back_log</ParamName>
        </ParameterDetail>
        <ParameterDetail>
              <ParamValue>ROW</ParamValue>
              <ParamName>binlog_format</ParamName>
        </ParameterDetail>
        <DBVersion>8.0</DBVersion>
        <ParameterGroupId>pcpg-**************</ParameterGroupId>
        <ForceRestart>1</ForceRestart>
        <ParameterGroupName>test</ParameterGroupName>
        <CreateTime>2021-03-10T08:40:39Z</CreateTime>
        <ParameterGroupDesc>testgroup</ParameterGroupDesc>
        <ParameterGroupType>1</ParameterGroupType>
        <ParameterCounts>2</ParameterCounts>
        <DBType>MySQL</DBType>
  </ParameterGroup>
</DescribeParameterGroupResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.