全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeParameterGroups - 查询参数组信息

更新时间:Sep 10, 2026

该接口用于查询用户创建或系统支持的数据库参数组列表,包括各参数组的基本信息、关联引擎类型及修改时间等。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeParameterGroups

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

实例所在地域。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

9B2F3840-5C98-475C-B269-2D5C3A31797C

Data

object

实例详情列表。

RequestId

string

请求 ID。

1E5DCFFC-A00D-****-836E-73318F8CA577

ParameterGroups

array<object>

参数模板名称。

object

参数模板列表。

ParameterGroupId

string

参数模板 ID。

说明

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

rpg-s1y1xy06****fqs7y

GmtCreated

string

账号创建时间。

2024-12-19T16:41:31+08:00

GmtModified

string

修改时间,时间戳格式。

1605079985000

DbType

string

数据库类型。

polarx

DbVersion

string

数据库版本。

5.7

DnParamCount

integer

DN 参数数量

10

DnForceRestart

boolean

DN 强制重启

CnParamCount

integer

CN 参数数量

10

CnForceRestart

boolean

CN 强制重启

Series

string

实例系列,取值如下:

  • enterprise:企业版

  • standard:标准版

enterprise

ParameterGroupName

string

参数模板名称。

dstest_api_new

ParameterGroupType

string

参数模板类型

0

示例

正常返回示例

JSON格式

{
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Data": {
    "RequestId": "1E5DCFFC-A00D-****-836E-73318F8CA577",
    "ParameterGroups": [
      {
        "ParameterGroupId": "rpg-s1y1xy06****fqs7y",
        "GmtCreated": "2024-12-19T16:41:31+08:00",
        "GmtModified": "1605079985000",
        "DbType": "polarx",
        "DbVersion": "5.7",
        "DnParamCount": 10,
        "DnForceRestart": true,
        "CnParamCount": 10,
        "CnForceRestart": true,
        "Series": "enterprise",
        "ParameterGroupName": "dstest_api_new",
        "ParameterGroupType": "0"
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情