文档

DescribeParameterGroups - 查询参数模版列表

更新时间:

查询可用的参数模版列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID,您可以调用 DescribeRegions 查询。

cn-hangzhou
DbTypestring

引擎类型,取值:

  • redis:Redis 社区版或 Tair 内存型。
  • tair_pena:Tair 持久内存型。
  • tair_pdb:Tair 磁盘型(ESSD/SSD)。
redis

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

686BB8A6-BBA5-47E5-8A75-D2ADE433****
ParameterGroupsarray<object>

参数模版列表。

ParameterGroupobject
EngineVersionstring

引擎兼容版本。

5
Modifiedstring

参数模板的最近修改时间。

2023-04-18 16:32:45
ParameterGroupNamestring

参数模版名称。

testGroupName
ParameterGroupDescstring

参数模版的描述信息。

test
Enginestring

引擎类型,取值如下:

  • redis:Redis 或 Tair 内存型。
  • tair_pena:Tair 持久内存型。
  • tair_pdb:Tair 磁盘型。
tair_pena
ParamGroupIdstring

参数模板 ID。

test01
Createdstring

参数模版的创建时间。

2023-04-18 16:32:45
Categorylong

产品类别,取值:

  • 0:社区版
  • 1:Tair(Redis 企业版)
0

示例

正常返回示例

JSON格式

{
  "RequestId": "686BB8A6-BBA5-47E5-8A75-D2ADE433****",
  "ParameterGroups": [
    {
      "EngineVersion": "5",
      "Modified": "2023-04-18 16:32:45",
      "ParameterGroupName": "testGroupName",
      "ParameterGroupDesc": "test",
      "Engine": "tair_pena",
      "ParamGroupId": "test01",
      "Created": "2023-04-18 16:32:45\n",
      "Category": 0
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-17OpenAPI 入参发生变更查看变更详情