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

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

说明 当前仅支持MySQL实例和PostgreSQL实例。

调试

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

请求参数

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

系统规定参数。取值:DescribeParameterGroup

ParameterGroupId String rpg-dp****

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

RegionId String cn-hangzhou

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

返回数据

名称 类型 示例值 描述
RequestId String 498AE8CA-8C81-4A01-AF37-2B902014ED30

请求ID。

ParamGroup Array of ParameterGroup

参数模板信息列表。

ParameterGroup
UpdateTime String 2019-10-22T06:07:54Z

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

ParameterGroupDesc String testGroup1

参数模板描述。

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

参数模板创建时间。

ForceRestart Integer 1

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

  • 0:不需要重启
  • 1:需要重启
ParameterGroupId String rpg-dp****

参数模板ID。

ParameterGroupName String test123456

参数模板名称。

Engine String mysql

数据库引擎。

ParamCounts Integer 2

参数模板内的参数数量。

EngineVersion String 5.6

数据库版本。

ParameterGroupType Integer 1

参数模板类型。取值:

  • 0:系统默认模板
  • 1:用户自定义模板
  • 2:系统自动备份模板(应用模板后系统会自动备份之前的参数设置为模板)
ParamDetail Array of ParameterDetail

参数列表。

ParameterDetail
ParamName String back_log

参数名称。

ParamValue String 2000

参数值。

RelatedCustinsInfo Array of RelatedCustinsInfo

关联实例信息。

说明 仅PostgreSQL模板适用。
RelatedCustinsInfo
DBInstanceName String rm-bp170****

实例ID。

AppliedTime String 2022-10-17T03:19:02Z

应用参数模板的时间。

示例

请求示例

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

正常返回示例

XML格式

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

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

错误码

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