Query information about a parameter template -

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	DescribeParameterGroup	The operation that you want to perform. Set the value to DescribeParameterGroup.
ParameterGroupId	String	Yes	rpg-dp****	The ID of the parameter template. You can call the DescribeParameterGroups operation to query the IDs of parameter templates.
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.

Response parameters


Parameter	Type	Example	Description
RequestId	String	498AE8CA-8C81-4A01-AF37-2B902014ED30	The ID of the request.
ParamGroup	Array of ParameterGroup		The information about the parameter template.
ParameterGroup
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.
ParameterGroupDesc	String	testGroup1	The description of the parameter template.
CreateTime	String	2019-10-22T06:02:53Z	The time when the parameter template was created.
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-dp****	The ID of the parameter template.
ParameterGroupName	String	test123456	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.6	The database engine version.
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.
ParamDetail	Array of ParameterDetail		The array of parameters.
ParameterDetail
ParamName	String	back_log	The name of the parameter.
ParamValue	String	2000	The value of the parameter.
RelatedCustinsInfo	Array of RelatedCustinsInfo		The instance to which the parameter template was applied. Note The RelatedCustinsInfo parameter is available only for ApsaraDB RDS for PostgreSQL instances.
RelatedCustinsInfo
DBInstanceName	String	rm-bp170****	The ID of the instance.
AppliedTime	String	2022-10-17T03:19:02Z	The time when the parameter template was applied.

Examples

Sample requests

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

Sample success responses

XML format

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

<DescribeParameterGroupResponse>
    <RequestId>498AE8CA-8C81-4A01-AF37-2B902014ED30</RequestId>
    <ParamGroup>
        <UpdateTime>2019-10-22T06:07:54Z</UpdateTime>
        <ParameterGroupDesc>testGroup1</ParameterGroupDesc>
        <CreateTime>2019-10-22T06:02:53Z</CreateTime>
        <ForceRestart>1</ForceRestart>
        <ParameterGroupId>rpg-dp****</ParameterGroupId>
        <ParameterGroupName>test123456</ParameterGroupName>
        <Engine>mysql</Engine>
        <ParamCounts>2</ParamCounts>
        <EngineVersion>5.6</EngineVersion>
        <ParameterGroupType>1</ParameterGroupType>
        <ParamDetail>
            <ParamName>back_log</ParamName>
            <ParamValue>2000</ParamValue>
        </ParamDetail>
    </ParamGroup>
    <RelatedCustinsInfo>
        <DBInstanceName>rm-bp170****</DBInstanceName>
        <AppliedTime>2022-10-17T03:19:02Z</AppliedTime>
    </RelatedCustinsInfo>
</DescribeParameterGroupResponse>

JSON format

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

{
  "RequestId" : "498AE8CA-8C81-4A01-AF37-2B902014ED30",
  "ParamGroup" : [ {
    "UpdateTime" : "2019-10-22T06:07:54Z",
    "ParameterGroupDesc" : "testGroup1",
    "CreateTime" : "2019-10-22T06:02:53Z",
    "ForceRestart" : 1,
    "ParameterGroupId" : "rpg-dp****",
    "ParameterGroupName" : "test123456",
    "Engine" : "mysql",
    "ParamCounts" : 2,
    "EngineVersion" : "5.6",
    "ParameterGroupType" : 1,
    "ParamDetail" : [ {
      "ParamName" : "back_log",
      "ParamValue" : "2000"
    } ]
  } ],
  "RelatedCustinsInfo" : [ {
    "DBInstanceName" : "rm-bp170****",
    "AppliedTime" : "2022-10-17T03:19:02Z"
  } ]
}

Error codes

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