Query configuration and running parameters with DescribeParameters - Tair (Redis® OSS-Compatible)

Queries the configuration and runtime parameters of a Tair (ApsaraDB for Redis) instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeParameters

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region in which to create the instance. Call the DescribeRegions operation to query available regions.	cn-hangzhou
DBInstanceId	string	Yes	The instance ID.	r-bp1zxszhcgatnx****
NodeId	string	No	The node ID. Note Use this parameter to query the configuration of a specific node in a cluster instance.	r-bp1xxxxxxxxxxxxx-db-0

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	9C1338BE-8DE8-4890-A900-E1BC06BF****
Engine	string	The database engine.	redis
EngineVersion	string	The engine version.	4.0
ConfigParameters	object
Parameter	array<object>	A list of configuration parameters that have not yet taken effect.
	object	A configuration parameter object.
CheckingCode	string	The validation rule that defines the allowed values for the parameter.	[0\|1]
ParameterName	string	The parameter name.	script_check_enable
ParameterValue	string	The parameter value.	1
ForceRestart	boolean	Indicates whether a restart is required for the change to take effect. Valid values: true: A restart is required. false: A restart is not required. The change takes effect immediately.	true
ParameterDescription	string	The parameter description.	Check all keys passed in the KEYS array map to the same slot.
ModifiableStatus	boolean	Indicates whether the parameter is modifiable. Valid values: false: The parameter is not modifiable. true: The parameter is modifiable.	true
RunningParameters	object
Parameter	array<object>	A list of the current runtime parameters.
	object	A runtime parameter object.
CheckingCode	string	The validation rule that defines the allowed values for the parameter.	[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

Examples

Success response

JSON format

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
404	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.