Parameter overview and configuration guide

• yes: specifies that the system checks whether a client IP address is in a whitelist.
• no: disables the compatibility with the Sentinel mode. This is the default value.

Specifies the commands that you want to disable, including FLUSHALL, FLUSHDB, KEYS, HGETALL, EVAL, EVALSHA, and SCRIPT.

• yes: enables SSL-based connections.
• no: disables the compatibility with the Sentinel mode. 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.

• 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 output buffer of the client is larger than or equal to the value specified by the soft limit field and if this 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.

The upper limit of the number of bytes in each key-value pair stored in a hash to support ziplist encoding. The ziplist data structure is used only if both of the following conditions are met:

1. The number of bytes in 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.

The upper limit of the number of bytes in each key-value pair stored in a hash to support ziplist encoding. The ziplist data structure is used only if both of the following conditions are met:

1. The number of bytes in 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 Lazyfree to evict data.
• no: disables Lazyfree to evict data. This is the default value.

• yes: enables Lazyfree to delete expired keys. This is the default value.
• no: disables asynchronous deletion.

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

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

• 0: specifies that no node of the list is compressed. This is the default value.
• 1: specifies that the first node from each side of the list is not compressed, but all nodes between these two nodes are compressed.
• 2: specifies that the first two nodes from each side of the list are not compressed, but all nodes between these four nodes are compressed.
• 3: specifies that the first three nodes from each side of the list are not compressed, but all nodes between these six nodes are compressed.
• Other values specify similar rules.

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

The types of events of which the Redis server can notify clients. The value of this parameter is any combination of the following characters,

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

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 only contains 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 exceeded the specified value.

Value range: 0 to 10000000. Default value: 10000. Unit: microseconds.

The upper limit of the number of key-value pairs stored in a sorted set to support ziplist encoding. A sorted set uses ziplist encoding when both of the following conditions are met:

1. The number of bytes in 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.

The upper limit of the number of bytes in each key-value pair stored in a sorted set to support ziplist encoding. A sorted set uses ziplist encoding when both of the following conditions are met:

1. The number of bytes in 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.

The upper limit of the number of bytes in each element stored in a list to support ziplist encoding. A list uses ziplist encoding when 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.

The upper limit of the number of bytes in each element stored in a list to support ziplist encoding. A list uses ziplist encoding when 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 with the native Redis cluster syntax.
• 1: enables the compatibility with the native Redis cluster syntax. This is the default value.

• 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: the default value indicates that the Lua execution mode is disabled. Read-only replicas do not support Lua, and the Lua command is processed by the primary node.
• 1: indicating that the Lua execution mode is enabled. Lua that only includes read operations will be forwarded to the read-only replica.

• 0: the default value, indicates that the function is disabled.
• 1: indicates that this feature is enabled. Redis Proxy will SUBSCRIBE convert to PSUBSCRIBE processing. If you use the PUB/SUB commands in the Lua, you can enable the function when the channel to be subscribed cannot receive the notification.

• yes: specifies that the system checks whether a client IP address is in a whitelist.
• no: disables the compatibility with the Sentinel mode. This is the default value.

Specifies the commands that you want to disable, including FLUSHALL, FLUSHDB, KEYS, HGETALL, EVAL, EVALSHA, and SCRIPT.

• yes: enables SSL-based connections.
• no: disables the compatibility with the Sentinel mode. 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.

• 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 output buffer of the client is larger than or equal to the value specified by the soft limit field and if this 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.

The upper limit of the number of bytes in each key-value pair stored in a hash to support ziplist encoding. The ziplist data structure is used only if both of the following conditions are met:

1. The number of bytes in 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.

The upper limit of the number of bytes in each key-value pair stored in a hash to support ziplist encoding. The ziplist data structure is used only if both of the following conditions are met:

1. The number of bytes in 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 Lazyfree to evict data.
• no: disables Lazyfree to evict data. This is the default value.

• yes: enables Lazyfree to delete expired keys. This is the default value.
• no: disables asynchronous deletion.

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

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

• 0: specifies that no node of the list is compressed. This is the default value.
• 1: specifies that the first node from each side of the list is not compressed, but all nodes between these two nodes are compressed.
• 2: specifies that the first two nodes from each side of the list are not compressed, but all nodes between these four nodes are compressed.
• 3: specifies that the first three nodes from each side of the list are not compressed, but all nodes between these six nodes are compressed.
• Other values specify similar rules.

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

The types of events of which the Redis server can notify clients. The value of this parameter is any combination of the following characters,

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

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 only contains 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 exceeded the specified value.

Value range: 0 to 10000000. Default value: 10000. Unit: microseconds.

The upper limit of the number of key-value pairs stored in a sorted set to support ziplist encoding. A sorted set uses ziplist encoding when both of the following conditions are met:

1. The number of bytes in 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.

The upper limit of the number of bytes in each key-value pair stored in a sorted set to support ziplist encoding. A sorted set uses ziplist encoding when both of the following conditions are met:

1. The number of bytes in 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.

The upper limit of the number of bytes in each element stored in a list to support ziplist encoding. A list uses ziplist encoding when 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.

The upper limit of the number of bytes in each element stored in a list to support ziplist encoding. A list uses ziplist encoding when 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 with the native Redis cluster syntax.
• 1: enables the compatibility with the native Redis cluster syntax. This is the default value.

• 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: the default value indicates that the Lua execution mode is disabled. Read-only replicas do not support Lua, and the Lua command is processed by the primary node.
• 1: indicating that the Lua execution mode is enabled. Lua that only includes read operations will be forwarded to the read-only replica.

• 0: the default value, indicates that the function is disabled.
• 1: indicates that this feature is enabled. Redis Proxy will SUBSCRIBE convert to PSUBSCRIBE processing. If you use the PUB/SUB commands in the Lua, you can enable the function when the channel to be subscribed cannot receive the notification.

• yes: specifies that the system checks whether a client IP address is in a whitelist.
• no: disables the compatibility with the Sentinel mode. This is the default value.

Specifies the commands that you want to disable, including FLUSHALL, FLUSHDB, KEYS, HGETALL, EVAL, EVALSHA, and SCRIPT.

• yes: enables SSL-based connections.
• no: disables the compatibility with the Sentinel mode. 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.

• 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 output buffer of the client is larger than or equal to the value specified by the soft limit field and if this 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.

The upper limit of the number of bytes in each key-value pair stored in a hash to support ziplist encoding. The ziplist data structure is used only if both of the following conditions are met:

1. The number of bytes in 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.

The upper limit of the number of bytes in each key-value pair stored in a hash to support ziplist encoding. The ziplist data structure is used only if both of the following conditions are met:

1. The number of bytes in 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 Lazyfree to evict data.
• no: disables Lazyfree to evict data. This is the default value.

• yes: enables Lazyfree to delete expired keys. This is the default value.
• no: disables asynchronous deletion.

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

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

• 0: specifies that no node of the list is compressed. This is the default value.
• 1: specifies that the first node from each side of the list is not compressed, but all nodes between these two nodes are compressed.
• 2: specifies that the first two nodes from each side of the list are not compressed, but all nodes between these four nodes are compressed.
• 3: specifies that the first three nodes from each side of the list are not compressed, but all nodes between these six nodes are compressed.
• Other values specify similar rules.

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

The types of events of which the Redis server can notify clients. The value of this parameter is any combination of the following characters,

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

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 only contains 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 exceeded the specified value.

Value range: 0 to 10000000. Default value: 10000. Unit: microseconds.

The upper limit of the number of key-value pairs stored in a sorted set to support ziplist encoding. A sorted set uses ziplist encoding when both of the following conditions are met:

1. The number of bytes in 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.

The upper limit of the number of bytes in each key-value pair stored in a sorted set to support ziplist encoding. A sorted set uses ziplist encoding when both of the following conditions are met:

1. The number of bytes in 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.

The upper limit of the number of bytes in each element stored in a list to support ziplist encoding. A list uses ziplist encoding when 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.

The upper limit of the number of bytes in each element stored in a list to support ziplist encoding. A list uses ziplist encoding when 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 with the native Redis cluster syntax.
• 1: enables the compatibility with the native Redis cluster syntax. This is the default value.

• 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: the default value, indicates that the Lua execution mode is disabled. Read-only replicas do not support Lua, and the Lua command is processed by the primary node.
• 1: indicating that the Lua execution mode is enabled. Lua that only includes read operations will be forwarded to the read-only replica.

• 0: the default value, indicates that the function is disabled.
• 1: indicates that this feature is enabled. Redis Proxy will SUBSCRIBE convert to PSUBSCRIBE processing. If you use the PUB/SUB commands in the Lua, you can enable the function when the channel to be subscribed cannot receive the notification.