You can call DescribeParameters to query the configuration and operational parameters of an ApsaraDB for Redis instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeParameters

The operation that you want to perform. Set this parameter to DescribeParameters.

DBInstanceId String Yes r-bp1xxxxxxxxxxxxx

The ID of the instance for which you want to query the maximum internal bandwidth.

NodeId String No r-bp1xxxxxxxxxxxxx-db-0#6889415

The ID of the node in the cluster. You need to specify this parameter when you query a specified node in the cluster.

Response parameters

Prameter Type Sample response Description
ConfigParameters Array

The configuration parameters that were returned.

Parameter
CheckingCode String [0|1]

The valid values of the parameter, which are used for verification.

ForceRestart Boolean True

Indicates whether a restart is required for the modification to the parameter to take effect. Valid values:

  • true: The modification takes effect after the instance is restarted.
  • false: The modification takes effect immediately after it is submitted.
ModifiableStatus Boolean True

Indicates whether the parameter can be modified. Valid values:

  • false
  • true
ParameterDescription String Check all keys passed in the KEYS array map to the same slot.

The description of the parameter.

ParameterName String script_check_enable

The name of the parameter.

ParameterValue String 1

The value of the parameter.

Engine String redis

The engine type of the instance.

EngineVersion String 4.0

The engine version of the instance.

RunningParameters Array

The operational parameters that were returned.

Parameter
CheckingCode String [0|1]

The valid values of the parameter, which are used for verification.

ForceRestart String true

Indicates whether a restart is required for the modification to the parameter to take effect. Valid values:

  • true: The modification takes effect after the instance is restarted.
  • false: The modification takes effect immediately after it is submitted.
ModifiableStatus String true

Indicates whether the parameter can be modified. Valid values:

  • 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].

The description of the parameter.

ParameterName String #no_loose_disabled-commands

The name of the parameter.

ParameterValue String keys,flushall,flushdb

The value of the parameter.

RequestId String 9C1338BE-8DE8-4890-A900-E1BC06BF7E1A

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/
?Action=DescribeParameters
&DBInstanceId=r-bp1xxxxxxxxxxxxx
&<Common request parameter>

Sample success response

XML format

<DescribeParametersResponse>
      <ConfigParameters></ConfigParameters>
      <RequestId>9C1338BE-8DE8-4890-A900-E1BC06BF7E1A</RequestId>
      <RunningParameters>
            <Parameter>
                  <ParameterDescription>check whitelist always</ParameterDescription>
                  <ParameterValue>no</ParameterValue>
                  <CheckingCode>[yes|no]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>#no_loose_check-whitelist-always</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>You can disable some dangerous commands, for example "keys,flushdb,flushall", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script]. </ParameterDescription>
                  <ParameterValue>keys,flushall,flushdb</ParameterValue>
                  <CheckingCode>. *</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>#no_loose_disabled-commands</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>Enable or disable SSL</ParameterDescription>
                  <ParameterValue>yes</ParameterValue>
                  <CheckingCode>[yes|no]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>#no_loose_ssl-enabled</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>Be compatible with cluster mode. </ParameterDescription>
                  <ParameterValue>0</ParameterValue>
                  <CheckingCode>[0|1]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>cluster_compat_enable</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>Check all keys passed in the KEYS array map to the same slot. </ParameterDescription>
                  <ParameterValue>1</ParameterValue>
                  <CheckingCode>[0|1]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>script_check_enable</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>If hash fields are less than this value and hash value sizes are less than hash-max-ziplist-value, the ziplist will be used. </ParameterDescription>
                  <ParameterValue>512</ParameterValue>
                  <CheckingCode>[0-999999999999999]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>hash-max-ziplist-entries</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>If hash value sizes are less than this value and hash fields are less than hash-max-ziplist-entries, the ziplist will be used. </ParameterDescription>
                  <ParameterValue>64</ParameterValue>
                  <CheckingCode>[0-999999999999999]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>hash-max-ziplist-value</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>lazyfree switch on eviction. </ParameterDescription>
                  <ParameterValue>yes</ParameterValue>
                  <CheckingCode>[yes|no]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>lazyfree-lazy-eviction</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>lazyfree switch on expire. </ParameterDescription>
                  <ParameterValue>yes</ParameterValue>
                  <CheckingCode>[yes|no]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>lazyfree-lazy-expire</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>lazyfree switch on server implicit deletion. </ParameterDescription>
                  <ParameterValue>yes</ParameterValue>
                  <CheckingCode>[yes|no]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>lazyfree-lazy-server-del</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>The number of entries on the list that are not compressed at both ends. </ParameterDescription>
                  <ParameterValue>0</ParameterValue>
                  <CheckingCode>[0-65535]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>list-compress-depth</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>Threadhold of ziplist size on quicklist. </ParameterDescription>
                  <ParameterValue>-2</ParameterValue>
                  <CheckingCode>[-5-99999999]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>list-max-ziplist-size</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>To config how Redis will select what to remove when maxmemory is reached. There are eight behaviors that can be chose : volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction</ParameterDescription>
                  <ParameterValue>volatile-lfu</ParameterValue>
                  <CheckingCode>[volatile-lru|allkeys-lru|volatile-random|allkeys-random|volatile-ttl|volatile-lfu|allkeys-lfu|noeviction]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>maxmemory-policy</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>
                Sets have a special encoding in just one case: when a set is composed
                of just strings that happen to be integers in radix 10 in the range
                of 64 bit signed integers.
                The following configuration setting sets the limit in the size of the
            set in order to use this special memory saving encoding. </ParameterDescription>
                  <ParameterValue>512</ParameterValue>
                  <CheckingCode>[0-999999999999999]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>set-max-intset-entries</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>
                The time is expressed in microseconds, so 1000000 is equivalent
                to one second. Note that a negative number disables the slow log,
            while a value of zero forces the logging of every command. </ParameterDescription>
                  <ParameterValue>10000</ParameterValue>
                  <CheckingCode>[0-10000000]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>slowlog-log-slower-than</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>The max slowlog count. </ParameterDescription>
                  <ParameterValue>1024</ParameterValue>
                  <CheckingCode>[100-10000]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>slowlog-max-len</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>
                Similarly to hashes and lists, sorted sets are also specially encoded in
            order to save a lot of space. </ParameterDescription>
                  <ParameterValue>128</ParameterValue>
                  <CheckingCode>[0-999999999999999]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>zset-max-ziplist-entries</ParameterName>
            </Parameter>
            <Parameter>
                  <ParameterDescription>
                Similarly to hashes and lists, sorted sets are also specially encoded in
            order to save a lot of space. </ParameterDescription>
                  <ParameterValue>64</ParameterValue>
                  <CheckingCode>[0-999999999999999]</CheckingCode>
                  <ForceRestart>false</ForceRestart>
                  <ModifiableStatus>true</ModifiableStatus>
                  <ParameterName>zset-max-ziplist-value</ParameterName>
            </Parameter>
      </RunningParameters>
      <EngineVersion>4.0</EngineVersion>
      <Engine>redis</Engine>
</DescribeParametersResponse>

JSON format

{
    "ConfigParameters": {
        "Parameter": []
    },
    "RequestId": "9C1338BE-8DE8-4890-A900-E1BC06BF7E1A",
    "RunningParameters": {
        "Parameter": [
            {
                "ParameterDescription": "check whitelist always",
                "ParameterValue": "no",
                "CheckingCode": "[yes|no]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "#no_loose_check-whitelist-always"
            },
            {
                "ParameterDescription": "You can disable some dangerous commands, for example \"keys,flushdb,flushall\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].",
                "ParameterValue": "keys,flushall,flushdb",
                "CheckingCode": ". *",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "#no_loose_disabled-commands"
            },
            {
                "ParameterDescription": "enable or disable SSL",
                "ParameterValue": "yes",
                "CheckingCode": "[yes|no]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "#no_loose_ssl-enabled"
            },
            {
                "ParameterDescription": "Be compatible with cluster mode.",
                "ParameterValue": "0",
                "CheckingCode": "[0|1]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "cluster_compat_enable"
            },
            {
                "ParameterDescription": "Check all keys passed in the KEYS array map to the same slot.",
                "ParameterValue": "1",
                "CheckingCode": "[0|1]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "script_check_enable"
            },
            {
                "ParameterDescription": "If hash fields are less than this value and hash value sizes are less than hash-max-ziplist-value, the ziplist will be used.",
                "ParameterValue": "512",
                "CheckingCode": "[0-999999999999999]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "hash-max-ziplist-entries"
            },
            {
                "ParameterDescription": "If hash value sizes are than less this value and hash fields are less than hash-max-ziplist-entries, the ziplist will be used.",
                "ParameterValue": "64",
                "CheckingCode": "[0-999999999999999]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "hash-max-ziplist-value"
            },
            {
                "ParameterDescription": "lazyfree switch on eviction.",
                "ParameterValue": "yes",
                "CheckingCode": "[yes|no]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "lazyfree-lazy-eviction"
            },
            {
                "ParameterDescription": "lazyfree switch on expire.",
                "ParameterValue": "yes",
                "CheckingCode": "[yes|no]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "lazyfree-lazy-expire"
            },
            {
                "ParameterDescription": "lazyfree switch on server implicit deletion.",
                "ParameterValue": "yes",
                "CheckingCode": "[yes|no]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "lazyfree-lazy-server-del"
            },
            {
                "ParameterDescription": "The number of entries on the list that are not compressed at both ends.",
                "ParameterValue": "0",
                "CheckingCode": "[0-65535]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "list-compress-depth"
            },
            {
                "ParameterDescription": "Threadhold of ziplist size on quicklist.",
                "ParameterValue": "-2",
                "CheckingCode": "[-5-99999999]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "list-max-ziplist-size"
            },
            {
                "ParameterDescription": "To config how Redis will select what to remove when maxmemory is reached. There are eight behaviors that can be chose : volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction",
                "ParameterValue": "volatile-lfu",
                "CheckingCode": "[volatile-lru|allkeys-lru|volatile-random|allkeys-random|volatile-ttl|volatile-lfu|allkeys-lfu|noeviction]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "maxmemory-policy"
            },
            {
                "ParameterDescription": "Sets have a special encoding in just one case: when a set is composed\nof just strings that happen to be integers in radix 10 in the range\nof 64 bit signed integers.\nThe following configuration setting sets the limit in the size of the\nset in order to use this special memory saving encoding.",
                "ParameterValue": "512",
                "CheckingCode": "[0-999999999999999]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "set-max-intset-entries"
            },
            {
                "ParameterDescription": "The time is expressed in microseconds, so 1000000 is equivalent\nto one second. Note that a negative number disables the slow log,\nwhile a value of zero forces the logging of every command.",
                "ParameterValue": "10000",
                "CheckingCode": "[0-10000000]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "slowlog-log-slower-than"
            },
            {
                "ParameterDescription": "The max slowlog count.",
                "ParameterValue": "1024",
                "CheckingCode": "[100-10000]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "slowlog-max-len"
            },
            {
                "ParameterDescription": "Similarly to hashes and lists, sorted sets are also specially encoded in\norder to save a lot of space.",
                "ParameterValue": "128",
                "CheckingCode": "[0-999999999999999]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "zset-max-ziplist-entries"
            },
            {
                "ParameterDescription": "Similarly to hashes and lists, sorted sets are also specially encoded in\norder to save a lot of space.",
                "ParameterValue": "64",
                "CheckingCode": "[0-999999999999999]",
                "ForceRestart": "false",
                "ModifiableStatus": "true",
                "ParameterName": "zset-max-ziplist-value"
            }
        ]
    },
    "EngineVersion": "4.0",
    "Engine": "redis"
}

Error codes

Http status code Error code Error message Description
404 InvalidDBInstanceClass.NotFound Specified DB instance class is not found. The error message returned because the specified instance type is invalid. Check whether the instance type is correct.
403 IncorrectDBInstanceType Current DB instance type does not support this operation. The error message returned because the current instance type does not support this operation. You can only clone or back up a read-only instance.

For a list of error codes, visit the API Error Center.