调用DescribeParameterGroup接口查询目标参数模板详情。

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

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

调试

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

请求参数

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

系统规定参数,取值为DescribeParameterGroup

ParameterGroupId String pcpg-**************

参数模板ID。

说明 您可以通过DescribeParameterGroups接口查询目标地域下所有参数模板的详细信息,包括参数模板ID。
RegionId String cn-hangzhou

地域ID。

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

返回数据

名称 类型 示例值 描述
ParameterGroup Array of ParameterGroup

参数模板信息列表。

CreateTime String 2021-03-10T08:40:39Z

参数模板创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

DBType String MySQL

数据库引擎类型。

DBVersion String 8.0

数据库引擎版本号。

ForceRestart String 1

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

  • 0:不需要重启
  • 1:需要重启
ParameterCounts Integer 2

参数模板内的参数数量。

ParameterDetail Array of ParameterDetail

参数列表。

ParamName String back_log

参数名称。

ParamValue String 3000

参数值。

ParameterGroupDesc String testgroup

参数模板描述。

ParameterGroupId String pcpg-**************

参数模板ID。

ParameterGroupName String test

参数模板名称。

ParameterGroupType String 1

参数模板类型,取值范围如下:

  • 0:系统默认模板
  • 1:用户自定义模板
  • 2:系统自动备份模板(应用模板后系统会自动备份之前的参数设置为模板)
RequestId String F1F16757-D31B-49CA-9BF4-305BAF******

请求ID。

示例

请求示例

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

正常返回示例

XML格式

<DescribeParameterGroupResponse>
  <RequestId>F1F16757-D31B-49CA-9BF4-305BAF******</RequestId>
  <ParameterGroup>
        <ParameterDetail>
              <ParamValue>3000</ParamValue>
              <ParamName>back_log</ParamName>
        </ParameterDetail>
        <ParameterDetail>
              <ParamValue>ROW</ParamValue>
              <ParamName>binlog_format</ParamName>
        </ParameterDetail>
        <DBVersion>8.0</DBVersion>
        <ParameterGroupId>pcpg-**************</ParameterGroupId>
        <ForceRestart>1</ForceRestart>
        <ParameterGroupName>test</ParameterGroupName>
        <CreateTime>2021-03-10T08:40:39Z</CreateTime>
        <ParameterGroupDesc>testgroup</ParameterGroupDesc>
        <ParameterGroupType>1</ParameterGroupType>
        <ParameterCounts>2</ParameterCounts>
        <DBType>MySQL</DBType>
  </ParameterGroup>
</DescribeParameterGroupResponse>

JSON格式

{
	"RequestId": "F1F16757-D31B-49CA-9BF4-305BAF******",
	"ParameterGroup": [
		{
			"ParameterDetail": [
				{
					"ParamValue": "3000",
					"ParamName": "back_log"
				},
				{
					"ParamValue": "ROW",
					"ParamName": "binlog_format"
				}
			],
			"DBVersion": "8.0",
			"ParameterGroupId": "pcpg-**************",
			"ForceRestart": "1",
			"ParameterGroupName": "test",
			"CreateTime": "2021-03-10T08:40:39Z",
			"ParameterGroupDesc": "testgroup",
			"ParameterGroupType": 1,
			"ParameterCounts": 2,
			"DBType": "MySQL"
		}
	]
}

错误码

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