DescribeParameterGroup - 查询参数模版基本信息_云数据库 Redis 版(Redis)-阿里云帮助中心

查询参数模版基本信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
kvstore:DescribeParameterGroup	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
ParameterGroupId	string	是	参数模版 ID。	rpg-sys-00*****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	A501A191-BD70-5E50-98A9-C2A486A82****
ParameterGroup	object	返回参数模板对象。
EngineVersion	string	引擎兼容版本。	5.0
Modified	string	参数模板的最近修改时间。	2023-04-18 16:32:45
ParameterGroupName	string	参数模板名称。	testGroupName
ParameterGroupDesc	string	参数模版的描述信息。	test
Engine	string	参数模本引擎	redis
ParamGroupId	string	参数模板 ID，全局唯一。	sys-001*****
Created	string	参数模板的创建时间。	2023-04-18 16:32:45
Category	long	产品类别，取值： 0：社区版 1：Tair（Redis 企业版）	1
ParamGroupsDetails	object []	参数模板的参数详情。
ParamName	string	参数名称。	timeout
ParamValue	string	参数值。	1000

示例

正常返回示例

JSON格式

{
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "ParameterGroup": {
    "EngineVersion": "5.0",
    "Modified": "2023-04-18 16:32:45",
    "ParameterGroupName": "testGroupName",
    "ParameterGroupDesc": "test",
    "Engine": "redis",
    "ParamGroupId": "sys-001*****",
    "Created": "2023-04-18 16:32:45",
    "Category": 1,
    "ParamGroupsDetails": [
      {
        "ParamName": "timeout",
        "ParamValue": "1000"
      }
    ]
  }
}

错误码

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