Parameter overview and configuration guide

• yes: enables the system to check whether a client IP address is in a whitelist.
• no: disables the system to check whether a client IP address is in a whitelist. This is the default value.

• Specifies the commands to be disabled. You can disable risky commands or commands that have high time complexity, such as flushall, flushdb, keys, hgetall, eval, evalsha, and script, based on your business requirements.
• The commands must be written in lowercase letters. Separate multiple commands with commas (,).

• yes: enables SSL encryption.
• no: disables SSL encryption. This is the default value.

• yes: enables the compatibility with the Sentinel mode.
• no: disables the compatibility with the Sentinel mode. This is the default value.

• TLSv1
• TLSv1.1
• TLSv1.2

• 1: enables directional forwarding. Requests from accounts that have read-only permissions are forwarded to only read replicas.
• 0: disables directional forwarding. Requests from accounts that have read-only permissions are forwarded to all nodes including the primary node based on weights. This is the default value.

• yes: enables AOF persistence. This is the default value.
• no: disables AOF persistence.

• hard limit: disconnects a client if the output buffer of the client is larger than or equal to the value specified by the hard limit field. Unit: bytes.
• soft limit and soft seconds: disconnects a client if the two conditions are met. One of the condition is that the output buffer of the client is larger than or equal to the value specified by the soft limit field. The other condition is that the situation lasts for a period longer than or equal to the value specified by the soft seconds field. The soft limit value is measured in bytes, and the soft seconds value is measured in seconds.

• yes: enables a dynamic hz value. This is the default value.
• no: disables a dynamic hz value.

Specifies the maximum number of key-value pairs stored in a hash. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the hash is less than the value of the hash-max-ziplist-value parameter.
2. The number of key-value pairs stored in the hash is less than the value of the hash-max-ziplist-entries parameter.

Specifies the maximum number of bytes of the key or value of each key-value pair stored in a hash. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the hash is less than the value of the hash-max-ziplist-value parameter.
2. The number of key-value pairs stored in the hash is less than the value of the hash-max-ziplist-entries parameter.

• yes: enables the feature.
• no: disables the feature. This is the default value.

• yes: enables the feature. This is the default value.
• no: disables the feature.

• yes: enables asynchronous deletion based on the lazyfree mechanism. This is the default value.
• no: disables asynchronous deletion based on the lazyfree mechanism.

Specifies the number of entries that are not compressed at both ends of a list. Valid values: 0 to 65535.

• 0: does not compress any node of the list. This is the default value.
• 1: specifies that the first node from each end of the list is not compressed, but all nodes between these two nodes are compressed.
• 2: specifies that the first two nodes from each end of the list are not compressed, but all nodes between these four nodes are compressed.
• 3: specifies that the first three nodes from each end of the list are not compressed, but all nodes between these six nodes are compressed.
• You can specify other values based on the same rule.

• The maximum length of a ziplist in a quicklist. A positive value specifies the maximum number of elements in each ziplist of a quicklist. For example, if you set this parameter to 5, each ziplist of a quicklist can contain a maximum of five elements.
• A negative number indicates the maximum number of bytes in each ziplist of a quicklist. Valid values: [-5, -1], where:
  • -5: specifies that each ziplist of a quicklist cannot exceed 64 KB (1 KB = 1,024 bytes).
  • -4: specifies that each ziplist of a quicklist cannot exceed 32 KB.
  • -3: specifies that each ziplist of a quicklist cannot exceed 16 KB.
  • -2: specifies that each ziplist of a quicklist cannot exceed 8 KB. This is the default value.
  • -1: specifies that each ziplist of a quicklist cannot exceed 4 KB.

Specifies the policy that is used to evict data when the system runs out of memory. Valid values:

• volatile-lru: evicts the approximated least recently used (LRU) keys among keys that have time-to-live (TTL) values configured.
• allkeys-lru: evicts the approximated LRU keys.
• volatile-lfu: evicts the approximated least frequently used (LFU) keys among keys that have TTL values configured.
• allkeys-lfu: evicts the approximated LFU keys.
• volatile-random: evicts random keys among keys that have TTL values configured.
• allkeys-random: evicts random keys.
• volatile-ttl: evicts keys with the minimum TTL. The LRU, LFU, and volatile-ttl policies use approximated randomized algorithms.
• noeviction: specifies that the system does not evict any keys, but returns an error for write operations.

Specifies the types of events of which the Redis server can notify clients. The value of this parameter is a combination of the following characters. Each of the following characters specifies a type of events:

• K: keyspace events, published with the __keyspace@<db>__ prefix.
• E: key events, published with the __keyevent@<db>__ prefix.
• g: generic events that are not related to any specific commands, such as DEL, EXPIRE, and RENAME.
• l: events of list commands.
• s: events of set commands.
• h: events of hash commands.
• z: events of sorted set commands.
• x: events of expired keys. An expiration event is triggered when an expired key is deleted.
• e: the eviction events. An eviction event is triggered when a key is deleted due to the policy specified by the maxmemory-policy parameter.
• A: the alias for g$lshzxe.

Specifies the maximum number of data entries in a set to support inset encoding. A set uses inset encoding when both of the following conditions are met:

1. The number of entries in the set is less than or equal to the value of the set-max-intset-entries parameter.
2. The set contains only radix-10 integers in the range of 64-bit signed integers.

• Negative value: does not log slow queries.
• 0: logs all queries.
• Positive value: logs queries of which the duration exceeds the specified value.

Valid values: 0 to 10000000. Default value: 10000. Unit: microseconds.

Specifies the maximum number of key-value pairs stored in a sorted set. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the sorted set is less than the value of the zset-max-ziplist-value parameter.
2. The number of key-value pairs stored in the sorted set is less than the value of the zset-max-ziplist-entries parameter.

Specifies the maximum number of bytes of the key or value of each key-value pair stored in a sorted set. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the sorted set is less than the value of the zset-max-ziplist-value parameter.
2. The number of key-value pairs stored in the sorted set is less than the value of the zset-max-ziplist-entries parameter.

Specifies the maximum number of key-value pairs stored in a list. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes in each element stored in the list is less than the value of the list-max-ziplist-value parameter.
2. The number of elements stored in the list is less than the value of the list-max-ziplist-entries parameter.

Specifies the maximum number of bytes of the key or value of each key-value pair stored in a list. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes in each element stored in the list is less than the value of the list-max-ziplist-value parameter.
2. The number of elements stored in the list is less than the value of the list-max-ziplist-entries parameter.

• 0: disables the compatibility mode.
• 1: enables the compatibility mode. This is the default value.

If a proxy node does not receive responses from a data node after the proxy node forwards client requests to the data node, the requests are pending. You can specify this parameter to prevent request pending that is caused by different processing capabilities of the frontend and the backend of the proxy node. This prevents an increase of memory usage.

• 0: does not check whether the keys are mapped to the same slot.
• 1: checks whether the keys are mapped to the same slot. This is the default value.

• 0: disables Lua scripting. Read replicas do not support Lua scripts. The master node processes Lua scripts. This is the default value.
• 1: enables Lua scripting. Lua scripts that include only read requests are forwarded to read replicas.

• 0: disables this feature. The two commands are not interchangeable. This is the default value.
• 1: enables this feature. Redis Proxy can convert SUBSCRIBE to PSUBSCRIBE. You can enable this feature if you run the Pub/Sub commands in Lua scripts and the channel to which you have subscribed cannot receive messages.

• yes: enables the system to check whether a client IP address is in a whitelist.
• no: disables the system to check whether a client IP address is in a whitelist. This is the default value.

• Specifies the commands to be disabled. You can disable risky commands or commands that have high time complexity, such as flushall, flushdb, keys, hgetall, eval, evalsha, and script, based on your business requirements.
• The commands must be written in lowercase letters. Separate multiple commands with commas (,).

• yes: enables SSL encryption.
• no: disables SSL encryption. This is the default value.

• yes: enables the compatibility with the Sentinel mode.
• no: disables the compatibility with the Sentinel mode. This is the default value.

• TLSv1
• TLSv1.1
• TLSv1.2

• 1: enables directional forwarding. Requests from accounts that have read-only permissions are forwarded to only read replicas.
• 0: disables directional forwarding. Requests from accounts that have read-only permissions are forwarded to all nodes including the primary node based on weights. This is the default value.

• yes: enables AOF persistence. This is the default value.
• no: disables AOF persistence.

• hard limit: disconnects a client if the output buffer of the client is larger than or equal to the value specified by the hard limit field. Unit: bytes.
• soft limit and soft seconds: disconnects a client if the two conditions are met. One of the condition is that the output buffer of the client is larger than or equal to the value specified by the soft limit field. The other condition is that the situation lasts for a period longer than or equal to the value specified by the soft seconds field. The soft limit value is measured in bytes, and the soft seconds value is measured in seconds.

• yes: enables a dynamic hz value. This is the default value.
• no: disables a dynamic hz value.

Specifies the maximum number of key-value pairs stored in a hash. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the hash is less than the value of the hash-max-ziplist-value parameter.
2. The number of key-value pairs stored in the hash is less than the value of the hash-max-ziplist-entries parameter.

Specifies the maximum number of bytes of the key or value of each key-value pair stored in a hash. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the hash is less than the value of the hash-max-ziplist-value parameter.
2. The number of key-value pairs stored in the hash is less than the value of the hash-max-ziplist-entries parameter.

• yes: enables the feature.
• no: disables the feature. This is the default value.

• yes: enables the feature. This is the default value.
• no: disables the feature.

• yes: enables asynchronous deletion based on the lazyfree mechanism. This is the default value.
• no: disables asynchronous deletion based on the lazyfree mechanism.

Specifies the number of entries that are not compressed at both ends of a list. Valid values: 0 to 65535.

• 0: does not compress any node of the list. This is the default value.
• 1: specifies that the first node from each end of the list is not compressed, but all nodes between these two nodes are compressed.
• 2: specifies that the first two nodes from each end of the list are not compressed, but all nodes between these four nodes are compressed.
• 3: specifies that the first three nodes from each end of the list are not compressed, but all nodes between these six nodes are compressed.
• You can specify other values based on the same rule.

• The maximum length of a ziplist in a quicklist. A positive value specifies the maximum number of elements in each ziplist of a quicklist. For example, if you set this parameter to 5, each ziplist of a quicklist can contain a maximum of five elements.
• A negative number indicates the maximum number of bytes in each ziplist of a quicklist. Valid values: [-5, -1], where:
  • -5: specifies that each ziplist of a quicklist cannot exceed 64 KB (1 KB = 1,024 bytes).
  • -4: specifies that each ziplist of a quicklist cannot exceed 32 KB.
  • -3: specifies that each ziplist of a quicklist cannot exceed 16 KB.
  • -2: specifies that each ziplist of a quicklist cannot exceed 8 KB. This is the default value.
  • -1: specifies that each ziplist of a quicklist cannot exceed 4 KB.

Specifies the policy that is used to evict data when the system runs out of memory. Valid values:

• volatile-lru: evicts the approximated least recently used (LRU) keys among keys that have time-to-live (TTL) values configured.
• allkeys-lru: evicts the approximated LRU keys.
• volatile-lfu: evicts the approximated least frequently used (LFU) keys among keys that have TTL values configured.
• allkeys-lfu: evicts the approximated LFU keys.
• volatile-random: evicts random keys among keys that have TTL values configured.
• allkeys-random: evicts random keys.
• volatile-ttl: evicts keys with the minimum TTL. The LRU, LFU, and volatile-ttl policies use approximated randomized algorithms.
• noeviction: specifies that the system does not evict any keys, but returns an error for write operations.

Specifies the types of events of which the Redis server can notify clients. The value of this parameter is a combination of the following characters. Each of the following characters specifies a type of events:

• K: keyspace events, published with the __keyspace@<db>__ prefix.
• E: key events, published with the __keyevent@<db>__ prefix.
• g: generic events that are not related to any specific commands, such as DEL, EXPIRE, and RENAME.
• l: events of list commands.
• s: events of set commands.
• h: events of hash commands.
• z: events of sorted set commands.
• x: events of expired keys. An expiration event is triggered when an expired key is deleted.
• e: the eviction events. An eviction event is triggered when a key is deleted due to the policy specified by the maxmemory-policy parameter.
• A: the alias for g$lshzxe.

Specifies the maximum number of data entries in a set to support inset encoding. A set uses inset encoding when both of the following conditions are met:

1. The number of entries in the set is less than or equal to the value of the set-max-intset-entries parameter.
2. The set contains only radix-10 integers in the range of 64-bit signed integers.

• Negative value: does not log slow queries.
• 0: logs all queries.
• Positive value: logs queries of which the duration exceeds the specified value.

Valid values: 0 to 10000000. Default value: 10000. Unit: microseconds.

Specifies the maximum number of key-value pairs stored in a sorted set. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the sorted set is less than the value of the zset-max-ziplist-value parameter.
2. The number of key-value pairs stored in the sorted set is less than the value of the zset-max-ziplist-entries parameter.

Specifies the maximum number of bytes of the key or value of each key-value pair stored in a sorted set. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the sorted set is less than the value of the zset-max-ziplist-value parameter.
2. The number of key-value pairs stored in the sorted set is less than the value of the zset-max-ziplist-entries parameter.

Specifies the maximum number of key-value pairs stored in a list. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes in each element stored in the list is less than the value of the list-max-ziplist-value parameter.
2. The number of elements stored in the list is less than the value of the list-max-ziplist-entries parameter.

Specifies the maximum number of bytes of the key or value of each key-value pair stored in a list. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes in each element stored in the list is less than the value of the list-max-ziplist-value parameter.
2. The number of elements stored in the list is less than the value of the list-max-ziplist-entries parameter.

• 0: disables the compatibility mode.
• 1: enables the compatibility mode. This is the default value.

If a proxy node does not receive responses from a data node after the proxy node forwards client requests to the data node, the requests are pending. You can specify this parameter to prevent request pending that is caused by different processing capabilities of the frontend and the backend of the proxy node. This prevents an increase of memory usage.

• 0: does not check whether the keys are mapped to the same slot.
• 1: checks whether the keys are mapped to the same slot. This is the default value.

• 0: disables Lua scripting. Read replicas do not support Lua scripts. The master node processes Lua scripts. This is the default value.
• 1: enables Lua scripting. Lua scripts that include only read requests are forwarded to read replicas.

• 0: disables this feature. The two commands are not interchangeable. This is the default value.
• 1: enables this feature. Redis Proxy can convert SUBSCRIBE to PSUBSCRIBE. You can enable this feature if you run the Pub/Sub commands in Lua scripts and the channel to which you have subscribed cannot receive messages.

• yes: enables the system to check whether a client IP address is in a whitelist.
• no: disables the system to check whether a client IP address is in a whitelist. This is the default value.

• Specifies the commands to be disabled. You can disable risky commands or commands that have high time complexity, such as flushall, flushdb, keys, hgetall, eval, evalsha, and script, based on your business requirements.
• The commands must be written in lowercase letters. Separate multiple commands with commas (,).

• yes: enables SSL encryption.
• no: disables SSL encryption. This is the default value.

• yes: enables the compatibility with the Sentinel mode.
• no: disables the compatibility with the Sentinel mode. This is the default value.

• TLSv1
• TLSv1.1
• TLSv1.2

• 1: enables directional forwarding. Requests from accounts that have read-only permissions are forwarded to only read replicas.
• 0: disables directional forwarding. Requests from accounts that have read-only permissions are forwarded to all nodes including the primary node based on weights. This is the default value.

• yes: enables AOF persistence. This is the default value.
• no: disables AOF persistence.

• hard limit: disconnects a client if the output buffer of the client is larger than or equal to the value specified by the hard limit field. Unit: bytes.
• soft limit and soft seconds: disconnects a client if the two conditions are met. One of the condition is that the output buffer of the client is larger than or equal to the value specified by the soft limit field. The other condition is that the situation lasts for a period longer than or equal to the value specified by the soft seconds field. The soft limit value is measured in bytes, and the soft seconds value is measured in seconds.

• yes: enables a dynamic hz value. This is the default value.
• no: disables a dynamic hz value.

Specifies the maximum number of key-value pairs stored in a hash. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the hash is less than the value of the hash-max-ziplist-value parameter.
2. The number of key-value pairs stored in the hash is less than the value of the hash-max-ziplist-entries parameter.

Specifies the maximum number of bytes of the key or value of each key-value pair stored in a hash. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the hash is less than the value of the hash-max-ziplist-value parameter.
2. The number of key-value pairs stored in the hash is less than the value of the hash-max-ziplist-entries parameter.

• yes: enables the feature.
• no: disables the feature. This is the default value.

• yes: enables the feature. This is the default value.
• no: disables the feature.

• yes: enables asynchronous deletion based on the lazyfree mechanism. This is the default value.
• no: disables asynchronous deletion based on the lazyfree mechanism.

Specifies the number of entries that are not compressed at both ends of a list. Valid values: 0 to 65535.

• 0: does not compress any node of the list. This is the default value.
• 1: specifies that the first node from each end of the list is not compressed, but all nodes between these two nodes are compressed.
• 2: specifies that the first two nodes from each end of the list are not compressed, but all nodes between these four nodes are compressed.
• 3: specifies that the first three nodes from each end of the list are not compressed, but all nodes between these six nodes are compressed.
• You can specify other values based on the same rule.

• The maximum length of a ziplist in a quicklist. A positive value specifies the maximum number of elements in each ziplist of a quicklist. For example, if you set this parameter to 5, each ziplist of a quicklist can contain a maximum of five elements.
• A negative number indicates the maximum number of bytes in each ziplist of a quicklist. Valid values: [-5, -1], where:
  • -5: specifies that each ziplist of a quicklist cannot exceed 64 KB (1 KB = 1,024 bytes).
  • -4: specifies that each ziplist of a quicklist cannot exceed 32 KB.
  • -3: specifies that each ziplist of a quicklist cannot exceed 16 KB.
  • -2: specifies that each ziplist of a quicklist cannot exceed 8 KB. This is the default value.
  • -1: specifies that each ziplist of a quicklist cannot exceed 4 KB.

Specifies the policy that is used to evict data when the system runs out of memory. Valid values:

• volatile-lru: evicts the approximated least recently used (LRU) keys among keys that have time-to-live (TTL) values configured.
• allkeys-lru: evicts the approximated LRU keys.
• volatile-lfu: evicts the approximated least frequently used (LFU) keys among keys that have TTL values configured.
• allkeys-lfu: evicts the approximated LFU keys.
• volatile-random: evicts random keys among keys that have TTL values configured.
• allkeys-random: evicts random keys.
• volatile-ttl: evicts keys with the minimum TTL. The LRU, LFU, and volatile-ttl policies use approximated randomized algorithms.
• noeviction: specifies that the system does not evict any keys, but returns an error for write operations.

Specifies the types of events of which the Redis server can notify clients. The value of this parameter is a combination of the following characters. Each of the following characters specifies a type of events:

• K: keyspace events, published with the __keyspace@<db>__ prefix.
• E: key events, published with the __keyevent@<db>__ prefix.
• g: generic events that are not related to any specific commands, such as DEL, EXPIRE, and RENAME.
• l: events of list commands.
• s: events of set commands.
• h: events of hash commands.
• z: events of sorted set commands.
• x: events of expired keys. An expiration event is triggered when an expired key is deleted.
• e: the eviction events. An eviction event is triggered when a key is deleted due to the policy specified by the maxmemory-policy parameter.
• A: the alias for g$lshzxe.

Specifies the maximum number of data entries in a set to support inset encoding. A set uses inset encoding when both of the following conditions are met:

1. The number of entries in the set is less than or equal to the value of the set-max-intset-entries parameter.
2. The set contains only radix-10 integers in the range of 64-bit signed integers.

• Negative value: does not log slow queries.
• 0: logs all queries.
• Positive value: logs queries of which the duration exceeds the specified value.

Valid values: 0 to 10000000. Default value: 10000. Unit: microseconds.

Specifies the maximum number of key-value pairs stored in a sorted set. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the sorted set is less than the value of the zset-max-ziplist-value parameter.
2. The number of key-value pairs stored in the sorted set is less than the value of the zset-max-ziplist-entries parameter.

Specifies the maximum number of bytes of the key or value of each key-value pair stored in a sorted set. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes of the key or value of each key-value pair stored in the sorted set is less than the value of the zset-max-ziplist-value parameter.
2. The number of key-value pairs stored in the sorted set is less than the value of the zset-max-ziplist-entries parameter.

Specifies the maximum number of key-value pairs stored in a list. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes in each element stored in the list is less than the value of the list-max-ziplist-value parameter.
2. The number of elements stored in the list is less than the value of the list-max-ziplist-entries parameter.

Specifies the maximum number of bytes of the key or value of each key-value pair stored in a list. The ziplist encoding is used only if both of the following conditions are met:

1. The number of bytes in each element stored in the list is less than the value of the list-max-ziplist-value parameter.
2. The number of elements stored in the list is less than the value of the list-max-ziplist-entries parameter.

• 0: disables the compatibility mode.
• 1: enables the compatibility mode. This is the default value.

If a proxy node does not receive responses from a data node after the proxy node forwards client requests to the data node, the requests are pending. You can specify this parameter to prevent request pending that is caused by different processing capabilities of the frontend and the backend of the proxy node. This prevents an increase of memory usage.

• 0: does not check whether the keys are mapped to the same slot.
• 1: checks whether the keys are mapped to the same slot. This is the default value.

• 0: disables Lua scripting. Read replicas do not support Lua scripts. The master node processes Lua scripts. This is the default value.
• 1: enables Lua scripting. Lua scripts that include only read requests are forwarded to read replicas.

• 0: disables this feature. The two commands are not interchangeable. This is the default value.
• 1: enables this feature. Redis Proxy can convert SUBSCRIBE to PSUBSCRIBE. You can enable this feature if you run the Pub/Sub commands in Lua scripts and the channel to which you have subscribed cannot receive messages.