调用DescribeParameterGroups查看目标地域的参数模板列表。

参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到PolarDB集群上。更多详情，请参见使用参数模板。

说明 当前仅支持PolarDB MySQL版集群。

调试

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

请求参数

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

系统规定参数。取值：DescribeParameterGroups。
RegionId String 是 cn-hangzhou

地域ID。

说明 您可以通过DescribeRegions接口查看当前账号下的所有可用地域信息，包括地域ID。
DBType String 否 MySQL

数据库引擎类型，当前仅支持MySQL类型。
DBVersion String 否 8.0

数据库引擎版本号，取值范围如下：

  • 5.6
  • 5.7
  • 8.0
ResourceGroupId String 否 rg-************

资源组ID。

返回数据

名称 类型 示例值 描述
RequestId String 944CED46-A6F7-40C6-B6DC-C6E5CC******

请求ID。
ParameterGroups Array of ParameterGroups

参数模板列表。
DBType String MySQL

数据库引擎类型。
DBVersion String 8.0

数据库引擎版本号。
ParameterGroupName String test

参数模板名称。
ForceRestart String 1

应用该参数模板是否需要重启集群，取直范围如下：

  • 0：不需要重启
  • 1：需要重启
ParameterGroupType String 1

参数模板类型，取值范围如下：

  • 0：系统默认模板
  • 1：用户自定义模板
  • 2：系统自动备份模板（应用模板后系统会自动备份之前的参数设置为模板）
ParameterCounts Long 2

参数模板内的参数数量。
ParameterGroupDesc String testgroup

参数模板描述。
CreateTime String 2023-03-10T08:40:39Z

参数模板创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
ParameterGroupId String pcpg-**************

参数模板ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeParameterGroups
&RegionId=cn-hangzhou
&DBType=MySQL
&DBVersion=8.0
&ResourceGroupId=rg-************
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeParameterGroupsResponse>
    <RequestId>944CED46-A6F7-40C6-B6DC-C6E5CC******</RequestId>
    <ParameterGroups>
        <DBType>MySQL</DBType>
        <DBVersion>8.0</DBVersion>
        <ParameterGroupName>test</ParameterGroupName>
        <ForceRestart>1</ForceRestart>
        <ParameterGroupType>1</ParameterGroupType>
        <ParameterCounts>2</ParameterCounts>
        <ParameterGroupDesc>testgroup</ParameterGroupDesc>
        <CreateTime>2023-03-10T08:40:39Z</CreateTime>
        <ParameterGroupId>pcpg-**************</ParameterGroupId>
    </ParameterGroups>
</DescribeParameterGroupsResponse>

JSON格式

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

{
  "RequestId" : "944CED46-A6F7-40C6-B6DC-C6E5CC******",
  "ParameterGroups" : [ {
    "DBType" : "MySQL",
    "DBVersion" : "8.0",
    "ParameterGroupName" : "test",
    "ForceRestart" : "1",
    "ParameterGroupType" : "1",
    "ParameterCounts" : 2,
    "ParameterGroupDesc" : "testgroup",
    "CreateTime" : "2023-03-10T08:40:39Z",
    "ParameterGroupId" : "pcpg-**************"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidRegionId.Malformed The specified parameter RegionId is not valid. 指定的参数RegionId无效。

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