Queries the parameter templates available in a region.

You can batch configure parameters in a parameter template and then apply it to your ApsaraDB for RDS instance. For more information, see Operate parameter templates.

Note This API operation is only available to ApsaraDB for RDS instances running MySQL.

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.

AccessKeyId String No LTAIfCxxxxxxx

The AccessKey ID provided to you by Alibaba Cloud.

Response parameters

Parameter Type Example Description
ParameterGroups Array

The parameter templates returned.

ParameterGroup

The parameter templates returned.

CreateTime String 2019-11-21T01:48:39Z

The time when a 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.

Engine String mysql

The database engine used by a parameter template.

EngineVersion String 5.7

The version of the database engine used by a parameter template.

ForceRestart Integer 1

Indicates whether a parameter template required the RDS instance on which it was applied to be restarted. Valid values:

  • 0: A restart was not required.
  • 1: A restart was required.
ParamCounts Integer 2

The number of parameters that were included in a parameter template.

ParameterGroupDesc String testgroup

The description of a parameter template.

ParameterGroupId String rpg-xxxxxxx

The ID of a parameter template.

ParameterGroupName String test1234

The name of a parameter template.

ParameterGroupType Integer 1

The type of a parameter template. Valid values:

  • 0: a default parameter template.
  • 1: a custom parameter template.
  • 2: an automatic backup parameter template. (After you apply this type of template to an RDS instance, the system automatically backs up the parameter settings of that instance and saves the data backup as a template.)
UpdateTime String 2019-11-21T02:21:35Z

The time when a 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.

RequestId String D4A23265-C5B6-42E1-98A0-EFA1EB42E723

The ID of the request.

Examples

Sample requests


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

Sample success responses

XML format

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

JSON format

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

Error codes

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