调用DescribeParameterGroup接口查询指定的RDS参数模板信息。

如果需要批量管理实例的参数，您可以使用参数模板功能，快速应用模板到实例上。详情请参见使用参数模板。

说明 当前仅支持MySQL实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeParameterGroup

系统规定参数。取值：DescribeParameterGroup。

RegionId String 是 cn-hangzhou

地域ID。可以通过接口DescribeRegions查看地域ID。

ParameterGroupId String 是 rpg-dpxxxxxxx

参数模板ID。可以通过接口DescribeParameterGroups查看参数模板ID。

AccessKeyId String 否 LTAIfCxxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

名称 类型 示例值 描述
ParamGroup Array

参数模板信息列表。
ParameterGroup

参数模板信息列表。
CreateTime String 2019-10-22T06:02:53Z

参数模板创建时间。
Engine String mysql

数据库引擎。
EngineVersion String 5.6

数据库版本。
ForceRestart Integer 1

应用该参数模板是否需要重启实例。取值：

  • 0：不需要重启
  • 1：需要重启
ParamCounts Integer 2

参数模板内的参数数量。
ParamDetail Array

参数列表。
ParameterDetail

参数列表。
ParamName String back_log

参数名称。
ParamValue String 2000

参数值。
ParameterGroupDesc String testGroup1

参数模板描述。
ParameterGroupId String rpg-dpxxxxxxx

参数模板ID。
ParameterGroupName String test123456

参数模板名称。
ParameterGroupType Integer 1

参数模板类型。取值：

  • 0：系统默认模板
  • 1：用户自定义模板
  • 2：系统自动备份模板（应用模板后系统会自动备份之前的参数设置为模板）
UpdateTime String 2019-10-22T06:07:54Z

最近一次参数模板更新时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

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

请求ID。

示例

请求示例


http(s)://rds.aliyuncs.com/?Action=DescribeParameterGroup
&RegionId=cn-hangzhou
&ParameterGroupId=rpg-xxxxxxx
&<公共请求参数>

正常返回示例

XML 格式 

<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 格式 

{
	"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"
						}
					]
				}
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。