DescribeParameterGroups - 查询参数模版列表-阿里云帮助中心

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
kvstore:DescribeParameterGroups	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID，您可以调用 DescribeRegions 查询。	cn-hangzhou
DbType	string	否	引擎类型，取值： redis：Redis 开源版或 Tair 内存型。 tair_pena：Tair 持久内存型。 tair_pdb：Tair 磁盘型（ESSD/SSD）。	redis

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	686BB8A6-BBA5-47E5-8A75-D2ADE433****
ParameterGroups	array<object>	参数模版列表。
ParameterGroup	object
EngineVersion	string	引擎兼容版本。	5
Modified	string	参数模板的最近修改时间。	2023-04-18 16:32:45
ParameterGroupName	string	参数模版名称。	testGroupName
ParameterGroupDesc	string	参数模版的描述信息。	test
Engine	string	引擎类型，取值如下： redis：Redis 开源版或 Tair 内存型。 tair_pena：Tair 持久内存型。 tair_pdb：Tair 磁盘型。	tair_pena
ParamGroupId	string	参数模板 ID。	test01
Created	string	参数模版的创建时间。	2023-04-18 16:32:45
Category	long	产品类别，取值： 0：Redis 开源版 1：Tair（企业版）	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-17	OpenAPI 入参发生变更	查看变更详情