调用DescribeParameterTemplates查询参数列表和默认值

查询Redis实例在不同架构和大版本下的参数列表和默认值。

接口说明

调用本接口查询到参数列表和默认值后，您还可以根据业务需求调用ModifyInstanceConfig接口修改Redis实例的参数。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
CharacterType	string	是	实例的架构，更多信息，请参见架构介绍。取值： logic：集群或读写分离架构。 normal：主从架构。当EngineVersion取值为6.0时，本参数不支持传入logic。	logic
Engine	string	是	数据库类型，取值固定为Redis。	Redis
EngineVersion	string	是	Redis实例的大版本，取值：2.8、4.0、5.0或6.0。	5.0
ResourceGroupId	string	否	资源组ID。您可以通过调用ListResourceGroups接口获取资源组ID。说明您也可以通过控制台获取资源组ID，相关操作，请参见查看资源组基本信息。	rg-acfmyiu4ekp****
InstanceId	string	否	实例ID，可调用DescribeInstances获取。	r-bp1zxszhcgatnx****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求ID。	9DA28D8E-514D-4F12-ADED-70A9C818****
Engine	string	数据库类型，返回值固定为Redis。	redis
EngineVersion	string	Redis实例的大版本。	5.0
ParameterCount	string	参数个数。	24
Parameters	object []	参数的详细信息列表。
CheckingCode	string	参数值的可选范围。	[yes\|no]
ParameterName	string	参数名，更多关于参数作用的介绍和设置说明，请参见参数说明。	appendonly
ParameterValue	string	参数默认值。	yes
ForceModify	boolean	参数是否可修改，返回值： true：可修改。 false：不可修改。	true
ForceRestart	boolean	参数修改后，是否需要重启生效，返回值： true：需要重启生效。 false：修改后立即生效，无需重启。	true
ParameterDescription	string	参数描述。	开启aof持久化模式

示例

正常返回示例

JSON格式

{
  "RequestId": "9DA28D8E-514D-4F12-ADED-70A9C818****",
  "Engine": "redis",
  "EngineVersion": "5.0",
  "ParameterCount": "24",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[yes|no]",
        "ParameterName": "appendonly",
        "ParameterValue": "yes",
        "ForceModify": true,
        "ForceRestart": true,
        "ParameterDescription": "开启aof持久化模式"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameters.Format	Specified parameters is not valid.	参数无效
403	ParamNotSupportedForCurrentVersion	Parameter is not supported for current version.	当前实例版本不支持改参数的修改

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