All Products
Search
Document Center

ApsaraDB for Redis:DescribeParameters

Last Updated:May 17, 2024

Queries the configuration parameters and running parameters of an ApsaraDB for Redis instance.

Operation description

This operation is available only for instances that use local disks.

Note You can call the DescribeInstanceConfig operation to query the parameter settings of instances that use cloud disks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:DescribeParametersRead
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DBInstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
NodeIdstringNo

The ID of the node.

Note You can set this parameter to query the parameter settings of the specified node in a cluster instance.
r-bp1xxxxxxxxxxxxx-db-0

Response parameters

ParameterTypeDescriptionExample
object

The information about the array object.

RequestIdstring

The ID of the request.

9C1338BE-8DE8-4890-A900-E1BC06BF****
Enginestring

The database engine that the instance runs.

redis
EngineVersionstring

The database engine version of the instance.

4.0
ConfigParametersobject []

The configuration parameters.

CheckingCodestring

The check code that indicates the valid values of the parameter.

[0|1]
ParameterNamestring

The name of the parameter.

script_check_enable
ParameterValuestring

The value of the parameter.

1
ForceRestartboolean

Indicates whether the instance must be restarted for the modifications to take effect. Valid values:

  • True: The instance must be restarted for the modifications to take effect.
  • False: The instance does not need to be restarted for the modifications to take effect. Modifications immediately take effect.
true
ParameterDescriptionstring

The description of the parameter.

Check all keys passed in the KEYS array map to the same slot.
ModifiableStatusboolean

Indicates whether the parameter can be reset. Valid values:

  • False: The parameter cannot be reset.
  • True: The parameter can be reset.
true
RunningParametersobject []

The running parameters.

CheckingCodestring

The check code that indicates the valid values of the parameter.

[0|1]
ParameterNamestring

The name of the parameter.

#no_loose_disabled-commands
ParameterValuestring

The value of the parameter.

keys,flushall,flushdb
ForceRestartstring

Indicates whether the instance must be restarted for the modifications to take effect. Valid values:

  • True: The instance must be restarted for the modifications to take effect.
  • False: The instance does not need to be restarted for the modifications to take effect. Modifications immediately take effect.
true
ParameterDescriptionstring

The description of the parameter.

You can disable some dangerous commands, for example \"keys,flushdb,flushall\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].
ModifiableStatusstring

Indicates whether the parameter can be reset. Valid values:

  • False: The parameter cannot be reset.
  • True: The parameter can be reset.
true

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation is not supported while the instance has the current category. Read-only instances can be cloned and backed up.
404InvalidDBInstanceClass.NotFoundSpecified DB instance class is not found.The instance type is invalid. Check the instance type.

For a list of error codes, visit the Service error codes.