调用DescribeParameters查询Redis实例的配置参数和运行参数-阿里云帮助中心

查询云数据库 Tair（兼容 Redis）实例的配置参数和运行参数。

接口说明

本接口仅支持查询经典版实例。

说明若实例为云原生版，您可以通过 DescribeInstanceConfig 接口进行查询。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
kvstore:DescribeParameters	get	DBInstance acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID，可调用 DescribeRegions 查询，使用此参数指定要创建实例的地域。	cn-hangzhou
DBInstanceId	string	是	实例 ID。	r-bp1zxszhcgatnx****
NodeId	string	否	节点 ID。说明传入本参数可查询集群实例中指定节点的参数配置。	r-bp1xxxxxxxxxxxxx-db-0

返回参数

名称	类型	描述	示例值
	object	对象。
RequestId	string	请求 ID。	9C1338BE-8DE8-4890-A900-E1BC06BF****
Engine	string	数据库类型。	redis
EngineVersion	string	数据库版本号。	4.0
ConfigParameters	array<object>	未生效的配置参数列表。
Parameter	object	对象。
CheckingCode	string	校验代码，参数的可选范围。	[0\|1]
ParameterName	string	参数名。	script_check_enable
ParameterValue	string	参数的值。	1
ForceRestart	boolean	是否需要重启生效，返回值： True：重启生效。 False：无需重启，提交后即生效。	true
ParameterDescription	string	参数的描述。	Check all keys passed in the KEYS array map to the same slot.
ModifiableStatus	boolean	参数是否可修改，返回值： False：不可修改。 True：可修改。	true
RunningParameters	array<object>	运行参数列表。
Parameter	object	对象。
CheckingCode	string	参数的可选范围。	[0\|1]
ParameterName	string	参数名。	#no_loose_disabled-commands
ParameterValue	string	参数的值。	keys,flushall,flushdb
ForceRestart	string	是否需要重启生效，返回值： True：重启生效。 False：无需重启，提交后即生效。	true
ParameterDescription	string	参数的描述。	You can disable some dangerous commands, for example \"keys,flushdb,flushall\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].
ModifiableStatus	string	参数是否可修改，返回值： False：不可修改。 True：可修改。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "9C1338BE-8DE8-4890-A900-E1BC06BF****",
  "Engine": "redis",
  "EngineVersion": "4.0",
  "ConfigParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "script_check_enable",
        "ParameterValue": "1",
        "ForceRestart": true,
        "ParameterDescription": "Check all keys passed in the KEYS array map to the same slot.",
        "ModifiableStatus": true
      }
    ]
  },
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "#no_loose_disabled-commands",
        "ParameterValue": "keys,flushall,flushdb",
        "ForceRestart": "true",
        "ParameterDescription": "You can disable some dangerous commands, for example \\\"keys,flushdb,flushall\\\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].",
        "ModifiableStatus": "true"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	由于实例类型不允许该操作，只读实例允许克隆和备份实例
404	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.	实例规格无效，请检查该参数是否正确。

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