DescribeParameterGroups--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DescribeParameterGroups

最近更新时间：2025.02.14 11:14:44首次发布时间：2025.02.14 11:14:44

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

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
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	Object[]		参数模板信息列表。
Total	Integer	1	参数模板总数。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeParameterGroups&Version=2020-12-07 HTTP/1.1
Host: redis.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-d2****",
        "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-cnlfm5yzmxehmkw****",
                "ParameterNum": 13,
                "Source": "User",
                "UpdateTime": "2025-01-09T02:51:23Z"
            }
        ],
        "Total": 1
    }
}

错误码

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