文档

DescribeParameterGroupTemplateList - 参数模版系统参数

更新时间:

查询参数模板中可配置参数的具体信息,例如默认值、取值范围、描述等。

调试

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

授权信息

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

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

请求参数

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

产品类别,取值:

  • standard:Redis 社区版
  • enterprise:Tair(Redis 企业版)
standard
EngineVersionstring

兼容版本,取值:

  • Redis 社区版支持5.06.07.0
  • Tair 内存型兼容 Redis 5.0、6.0 和 7.0 协议,传5.06.07.0
  • Tair 持久内存型兼容 Redis 6.0 协议,传1.0
  • Tair 磁盘(ESSD/SSD)兼容 Redis 6.0 协议。 创建 ESSD 型的参数模板请传入1.0、创建 SSD 型的参数模板请传入2.0
5.0
EngineTypestring

引擎类型,取值:

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

实例的角色类型,取值说明:

  • logic:集群逻辑实例
  • db:集群 DB 实例
  • proxy:集群 Proxy 实例
  • cs:集群 CS 实例
  • normal:主从 DB 实例
db

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

5D622714-AEDD-4609-9167-F5DDD3D1****
EngineVersionstring

兼容版本。

5
Parametersarray<object>

参数的详细信息列表。

Parametersobject

参数信息。

SupportModifyForMinorVersionboolean

是否支持修改小版本:

  • true:支持
  • false:不支持。
true
CheckingCodestring

参数取值范围。

[0|1]
ParameterValuestring

参数默认值。

10
Revisablelong

是否可以修改

  • 0:不能修改。
  • 1:修改。
0
Factorlong

整除因子。对于整数和字节类型的参数,参数值除了必须满足参数的可选范围,还须是 Factor(不等于 0)的倍数。

1
ParameterNamestring

参数名称。

appendonly
Unitstring

参数值单位。

  • INT:普通的整型。
  • STRING:固定的字符串。
  • B:字节。
STRING
ParameterDescriptionstring

参数描述。

开启Aof持久化模式。
Effectivelong

是否生效:

  • 0:否
  • 1:是
1

示例

正常返回示例

JSON格式

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "EngineVersion": "5",
  "Parameters": [
    {
      "SupportModifyForMinorVersion": true,
      "CheckingCode": "[0|1]",
      "ParameterValue": "10",
      "Revisable": 0,
      "Factor": 1,
      "ParameterName": "appendonly",
      "Unit": "STRING",
      "ParameterDescription": "开启Aof持久化模式。",
      "Effective": 1
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史