Queries information about a parameter template.

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 DescribeParameterGroup

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

RegionId String Yes cn-hangzhou

The region ID of the parameter template. You can call the DescribeRegions operation to query the most recent region list.

ParameterGroupId String Yes rpg-dpxxxxxxx

The ID of the parameter template. You can call the DescribeParameterGroups operation to query the most recent parameter templates in a specific region.

AccessKeyId String No LTAIfCxxxxxxx

The AccessKey ID provided to you by Alibaba Cloud.

Response parameters

Parameter Type Example Description
ParamGroup Array

The information returned for the parameter template.

ParameterGroup

The information returned for the parameter template.

CreateTime String 2019-10-22T06:02:53Z

The time when the parameter template was created.

Engine String mysql

The database engine used by the parameter template.

EngineVersion String 5.6

The version of the database engine used by the 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 the parameter template.

ParamDetail Array

The parameters that were included in the parameter template.

ParameterDetail

The details about the parameters that were included in the parameter template.

ParamName String back_log

The name of a parameter that was included in the parameter list.

ParamValue String 2000

The value of a parameter that was included in the parameter list.

ParameterGroupDesc String testGroup1

The description of the parameter template.

ParameterGroupId String rpg-dpxxxxxxx

The ID of the parameter template.

ParameterGroupName String test123456

The name of the parameter template.

ParameterGroupType Integer 1

The type of the 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-10-22T06:07:54Z

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.

RequestId String 498AE8CA-8C81-4A01-AF37-2B902014ED30

The ID of the request.

Examples

Sample requests


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

Sample success responses

XML format

<DescribeParameterGroupResponse>
  <RequestId>498AE8CA-8C81-4A01-AF37-2B902014ED30</RequestId>
  <ParamGroup>
        <ParameterGroup>
              <ParameterGroupType>1</ParameterGroupType>
              <ParameterGroupName>test123456</ParameterGroupName>
              <CreateTime>2019-10-22T06:02:53Z</CreateTime>
              <ParameterGroupDesc></ParameterGroupDesc>
              <ParamCounts>1</ParamCounts>
              <UpdateTime>2019-10-22T06:07:54Z</UpdateTime>
              <ForceRestart>1</ForceRestart>
              <EngineVersion>5.6</EngineVersion>
              <Engine>mysql</Engine>
              <ParamDetail>
                    <ParameterDetail>
                          <ParamName>back_log</ParamName>
                          <ParamValue>2000</ParamValue>
                    </ParameterDetail>
              </ParamDetail>
              <ParameterGroupId>rpg-xxxxxxx</ParameterGroupId>
        </ParameterGroup>
  </ParamGroup>
</DescribeParameterGroupResponse>

JSON format

{
	"RequestId":"498AE8CA-8C81-4A01-AF37-2B902014ED30",
	"ParamGroup":{
		"ParameterGroup":[
			{
				"ParameterGroupType":1,
				"ParameterGroupName":"test123456",
				"ParamCounts":1,
				"ParameterGroupDesc":"",
				"CreateTime":"2019-10-22T06:02:53Z",
				"ForceRestart":1,
				"UpdateTime":"2019-10-22T06:07:54Z",
				"EngineVersion":"5.6",
				"Engine": "mysql",
				"ParameterGroupId":"rpg-xxxxxxx",
				"ParamDetail":{
					"ParameterDetail":[
						{
							"ParamName":"back_log",
							"ParamValue":"2000"
						}
					]
				}
			}
		]
	}
}

Error codes

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