文档中心

缓存数据库 Redis 版

参数管理

DescribeParameterGroups

调用 DescribeParameterGroups 接口查询当前账号和地域下的参数模板的基本信息。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
EngineVersion	String	否	7.0	参数模板适用的 Redis 数据库版本。取值范围如下； 7.0：Redis 7.0。 6.0：Redis 6.0。 5.0：Redis 5.0。说明若该参数留空，表示不使用参数模板的数据库版本号条件进行筛选。
Source	String	否	User	参数模板的创建来源，取值范围如下： User：用户创建（即自定义模板）。 System：系统创建（即系统模板）。说明若该参数留空，表示不使用参数模板的创建来源条件进行筛选。
PageNumber	Integer	是	1	参数模板信息列表的页码。取值为不超过 Integer 数据类型的最大值，起始值均为 1。
PageSize	Integer	是	10	每页记录数。取值为 1~100 间的整数。

返回参数

参数	类型	示例值	描述
ParameterGroups	Array of ParameterGroupInfo	请参见返回示例。	参数模板信息列表。
Total	Integer	1	参数模板总数。

ParameterGroupInfo

参数	类型	示例值	描述
Name	String	test_temp	参数模板名称。
Source	String	User	参数模板的创建来源，取值范围如下： User：用户创建（即自定义模板）。 System：系统创建（即系统模板）。
Default	Boolean	false	是否为默认参数模板。说明缓存数据库 Redis 版本为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。更多详情，请参见参数模板管理。
CreateTime	String	2025-01-09T02:51:23Z	参数模板的创建时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
UpdateTime	String	2025-01-09T03:10:11Z	参数模板最近一次的更新时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
Description	String	test template	参数模板的描述信息。
ParameterNum	Integer	2	参数模板中包含的参数数量。
EngineVersion	String	7.0	参数模板适用的数据库版本。
ParameterGroupId	String	pg-cnlfm5yzmxehmkwbzk3	参数模板 ID。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeParameterGroups&Version=2020-12-07 HTTP/1.1​
Host: redis.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
    "EngineVersion": "7.0",​
    "Source": "User",​
    "PageNumber": 1,​
    "PageSize": 10​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20250109105318A40F83EE441D5D4985B1-d228ce",​
    "Action": "DescribeParameterGroups",​
    "Version": "2020-12-07",​
    "Service": "Redis",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "ParameterGroups": [​
      {​
        "CreateTime": "2025-01-09T02:51:23Z",​
        "Default": false,​
        "Description": "test template",​
        "EngineVersion": "7.0",​
        "Name": "test_temp",​
        "ParameterGroupId": "pg-cnlfm5yzmxehmkwbzk3",​
        "ParameterNum": 13,​
        "Source": "User",​
        "UpdateTime": "2025-01-09T02:51:23Z"​
      }​
    ],​
    "Total": 1​
  }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.09.21 14:23:32

这个页面对您有帮助吗？

有用

无用