Query parameter templates -

You can configure a number of parameters at a time by using a parameter template and then apply the parameter template to instances. For more information, see Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances or Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances.

Note You can apply parameter templates only to ApsaraDB RDS for MySQL instances and ApsaraDB RDS for PostgreSQL instances.

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	Yes	DescribeParameterGroups	The operation that you want to perform. Set this parameter to DescribeParameterGroups.
RegionId	String	Yes	cn-hangzhou	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.
ResourceGroupId	String	No	rg-acfmy****	The ID of the resource group.

Response parameters


Parameter	Type	Example	Description
SignalForOptimizeParams	Boolean	false	Indicates whether parameter templates exist in the specified region. Valid values: true false
RequestId	String	D4A23265-C5B6-42E1-98A0-EFA1EB42E723	The ID of the request.
ParameterGroups	Array of ParameterGroup		The details of parameter templates.
ParameterGroup
UpdateTime	String	2019-11-21T02:21:35Z	The time when the parameter template was last updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
ParameterGroupDesc	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 and saves the backup as a template.
CreateTime	String	2019-11-21T01:48: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.
ForceRestart	Integer	1	Indicates whether the restart of an instance is required for the parameter template to take effect. Valid values: 0: A restart is not required. 1: A restart is required.
ParameterGroupId	String	rpg-****	The ID of the parameter template.
ParameterGroupName	String	test1234	The name of the parameter template.
Engine	String	mysql	The database engine.
ParamCounts	Integer	2	The number of parameters in the parameter template.
EngineVersion	String	5.7	The database engine version of the instance.
ParameterGroupType	Integer	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 and saves the backup as a template.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeParameterGroupsResponse>
    <SignalForOptimizeParams>false</SignalForOptimizeParams>
    <RequestId>D4A23265-C5B6-42E1-98A0-EFA1EB42E723</RequestId>
    <ParameterGroups>
        <UpdateTime>2019-11-21T02:21:35Z</UpdateTime>
        <ParameterGroupDesc>1</ParameterGroupDesc>
        <CreateTime>2019-11-21T01:48:39Z</CreateTime>
        <ForceRestart>1</ForceRestart>
        <ParameterGroupId>rpg-****</ParameterGroupId>
        <ParameterGroupName>test1234</ParameterGroupName>
        <Engine>mysql</Engine>
        <ParamCounts>2</ParamCounts>
        <EngineVersion>5.7</EngineVersion>
        <ParameterGroupType>1</ParameterGroupType>
    </ParameterGroups>
</DescribeParameterGroupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "SignalForOptimizeParams" : false,
  "RequestId" : "D4A23265-C5B6-42E1-98A0-EFA1EB42E723",
  "ParameterGroups" : [ {
    "UpdateTime" : "2019-11-21T02:21:35Z",
    "ParameterGroupDesc" : "1",
    "CreateTime" : "2019-11-21T01:48:39Z",
    "ForceRestart" : 1,
    "ParameterGroupId" : "rpg-****",
    "ParameterGroupName" : "test1234",
    "Engine" : "mysql",
    "ParamCounts" : 2,
    "EngineVersion" : "5.7",
    "ParameterGroupType" : 1
  } ]
}

Error codes

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