DescribeParameters - 查询Redis实例的配置参数和运行参数_云原生内存数据库Tair-阿里云帮助中心

查询Redis实例的配置参数和运行参数。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
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	对象。
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	对象。
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 code	错误码	错误信息	描述
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	由于实例类型不允许该操作，只读实例允许克隆和备份实例
404	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.	实例规格无效，请检查该参数是否正确。

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