DescribeParameterGroups - PolarDB - Alibaba Cloud Documentation Center

Queries parameter templates that are available 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	DescribeParameterGroups	The operation that you want to perform. Set the value to DescribeParameterGroups.
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.
DBType	String	No	MySQL	The type of the database engine. Only MySQL is supported.
DBVersion	String	No	8.0	The version number of the database engine. Valid values: 5.6 5.7 8.0

Response parameters


Parameter	Type	Example	Description
ParameterGroups	Array of ParameterGroups		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 number 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	Long	2	The number of parameters 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	944CED46-A6F7-40C6-B6DC-C6E5CC******	The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeParameterGroupsResponse>
  <ParameterGroups>
        <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>
  </ParameterGroups>
  <RequestId>6F1574BE-9913-4C4C-99A9-0A42F3******</RequestId>
</DescribeParameterGroupsResponse>

JSON format

{
    "ParameterGroups": [
        {
            "DBVersion": "8.0",
            "ParameterGroupId": "pcpg-**************",
            "ForceRestart": "1",
            "ParameterGroupName": "test",
            "CreateTime": "2021-03-10T08:40:39Z",
            "ParameterGroupDesc": "testgroup",
            "ParameterGroupType": 1,
            "ParameterCounts": 2,
            "DBType": "MySQL"
        }
    ],
    "RequestId": "6F1574BE-9913-4C4C-99A9-0A42F3******"
    }

Error codes

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