调用DescribeParameterGroup查询指定的参数模板信息_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询目标参数模板详情。

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeParameterGroup	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。说明您可以通过 DescribeRegions 接口查看当前账号下的所有可用地域信息，包括地域 ID。	cn-hangzhou
ParameterGroupId	string	是	参数模板 ID。说明您可以通过 DescribeParameterGroups 接口查询目标地域下所有参数模板的详细信息，包括参数模板 ID。	pcpg-**************
ResourceGroupId	string	否	资源组 ID。	rg-************

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	F1F16757-D31B-49CA-9BF4-305BAF******
ParameterGroup	object []	参数模板信息列表。
DBType	string	数据库引擎类型。	MySQL
DBVersion	string	数据库引擎版本号。	8.0
ParameterGroupName	string	参数模板名称。	test
ForceRestart	string	应用该参数模板是否需要重启集群，取直范围如下： 0：不需要重启 1：需要重启	1
ParameterGroupType	string	参数模板类型，取值范围如下： 0：系统默认模板 1：用户自定义模板 2：系统自动备份模板（应用模板后系统会自动备份之前的参数设置为模板）	1
ParameterCounts	integer	参数模板内的参数数量。	2
ParameterGroupDesc	string	参数模板描述。	testgroup
CreateTime	string	参数模板创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。	2023-03-10T08:40:39Z
ParameterDetail	object []	参数列表。
ParamValue	string	参数值。	3000
ParamName	string	参数名称。	back_log
ParameterGroupId	string	参数模板 ID。	pcpg-**************

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	指定的参数RegionId无效
400	InvalidParameterGroupId.Malformed	The Specified parameter ParameterGroupId is not valid.	指定的参数ParameterGroupId无效

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史