Tair (Redis® OSS-Compatible):List of configurable parameters for Redis Open-Source Edition

Specifies whether to check if the client IP address is in the instance whitelist after you enable password-free access over a VPC. Valid values:

• yes: Enables the check. After you enable password-free access, you must add the IP address of a client in the same VPC to the instance whitelist to connect to the instance from that client.

  If you enable password-free access but do not correctly configure the whitelist, an error message similar to the following is returned: (error) ERR illegal address.

• no (default): Disables the check. After you enable password-free access, you do not need to add the IP address of a client in the same VPC to the instance whitelist to connect to the instance from that client.

The disabled commands. You can use this parameter to disable the commands that may have high risks or high time complexity based on your business requirements, such as FLUSHALL, FLUSHDB, KEYS, HGETALL, EVAL, EVALSHA, and SCRIPT.

Specifies whether to enable the Sentinel-compatible mode for standard instances or cluster instances in direct connection mode. Valid values:

• yes

• no (default)

Sets the minimum TLS version supported by the instance. Valid values:

• TLSv1 (default)

• TLSv1.1

• TLSv1.2

Enables or disables AOF persistence for the primary node. Valid values:

• yes (default): Enables AOF persistence.

• no: Disables AOF persistence.

  Note

  Redis database (RDB) persistence is performed once a day by default. For more information, see Automatic or manual backup.

pubsub limits the output buffer for publish/subscribe clients. Default value: 33554432 8388608 60.

normal limits the output buffer for regular clients. Default value: 524288000 0 0.

Specify values in the format: <hard limit> <soft limit> <soft seconds>.

• <hard limit>: Disconnects a client if its output buffer size reaches or exceeds this limit. Unit: bytes.

• <soft limit> and <soft seconds>: Disconnects a client if its output buffer size remains at or above the soft limit for at least the specified number of seconds. Unit for soft limit: bytes. Unit for soft seconds: seconds.

Enables or disables dynamic background task frequency adjustment. Valid values:

• yes (default): Enable.

• no: Disable.

For instances compatible with Redis 7.0 and later, listpack is used as the default codec for hashes. A hash object uses listpack encoding when both of the following conditions are met:

• The number of key-value pairs in the hash is less than the value of hash-max-listpack-entries.

• The string length of both the keys and values in the hash is less than the value of hash-max-listpack-value.

The execution frequency of instance background tasks, such as the task to clear expired keys. The range is [1-500]. The default is 10, which means 10 times per second.

Enables or disables per-command latency tracking. Valid values:

• yes (default): Enable.

• no: Disable.

Enables or disables lazyfree-based eviction. Valid values:

• yes: Enable.

• no (default): Disable.

Enables or disables lazyfree-based deletion of expired keys. Valid values:

• yes (default): Enable.

• no: Disable.

Specifies whether implicit DEL operations use lazyfree-based asynchronous deletion. Valid values:

• yes (default): Enable.

• no: Disable.

Automatically converts FLUSHDB, FLUSHALL, SCRIPT FLUSH, and FUNCTION FLUSH commands to lazyfree-based asynchronous deletion mode. Valid values:

• yes: Enable.

• no (default): Disable.

The number of uncompressed nodes at both ends of a list. The range is [0-65535].

• 0 (default): No nodes are compressed.

• 1-65535: The specified number of nodes at each end of the list are not compressed, while the nodes in the middle are compressed.

For instances compatible with Redis 6.0 and earlier, ziplist is the default codec for lists (the list-max-ziplist-size parameter). For instances compatible with Redis 7.0 and later, listpack is the default codec for lists (the list-max-listpack-size parameter).

• A positive value limits the length of the ziplist (or listpack) on each quicklist node by the number of data items. For example, if this parameter is set to 5, each quicklist node's ziplist (or listpack) can contain a maximum of 5 data items.

• A negative value limits the length of the ziplist (or listpack) on each quicklist node by the number of bytes occupied. Valid values:

  • -5: The size of the ziplist (or listpack) on each quicklist node cannot exceed 64 KB.

  • -4: The size of the ziplist (or listpack) on each quicklist node cannot exceed 32 KB.

  • -3: The size of the ziplist (or listpack) on each quicklist node cannot exceed 16 KB.

  • -2 (default): The size of the ziplist (or listpack) on each quicklist node cannot exceed 8 KB.

  • -1: The size of the ziplist (or listpack) on each quicklist node cannot exceed 4 KB.

The data eviction policy. When an instance runs out of memory and its usage reaches Maxmemory, data eviction is triggered. You can choose different data eviction policies. Valid values:

• volatile-lru (default for memory-optimized and Redis Open-Source Edition instances): From the keys with an expiration time (Expire) set, deletes the least recently used (LRU) key, regardless of whether the key has expired.

• noeviction (default for persistent memory instances): Does not delete any keys. When the memory limit is reached, new data cannot be written, and the database returns an error message.

• volatile-lfu: From the keys with an expiration time (Expire) set, deletes the least frequently used (LFU) key.

• volatile-random: From the keys with an expiration time (Expire) set, randomly deletes some keys.

• volatile-ttl: From the keys with an expiration time (Expire) set, deletes keys sorted by their time to live (TTL) in ascending order.

• allkeys-lru: From all keys, deletes the least recently used (LRU) key.

• allkeys-lfu: From all keys, deletes the least frequently used (LFU) key.

• allkeys-random: From all keys, randomly deletes some keys.

Eviction tenacity factor. Controls latency per eviction cycle. Valid values: [0–100]. Default: 10.

• Lower values reduce latency but may reduce eviction effectiveness.

• During high write traffic, increase this value—but latency will rise. A value of 100 ignores latency and continuously evicts until memory drops below maxmemory or no evictable keys remain.

Expired key deletion effort factor. Controls latency per expired key deletion cycle. Valid values: [1–10]. Default: 1. Higher values delete expired keys faster but consume more CPU.

The types of events of which the server can notify clients. The value of this parameter is a combination of the following characters. This parameter setting applies to all databases in the instance. These notifications consume CPU resources. For more information, see Redis keyspace notifications.

• K: keyspace events. All events are published with a _keyspace@<db>_ prefix.

• E: keyevent events. All events are published with a _keyevent@<db>_ prefix.

• g: generic events that are not related to specific commands, such as DEL, EXPIRE, and RENAME.

• $: events of string commands. Clients are notified of operations to create, modify, and delete strings.

• l: events of list commands.

• s: events of set commands.

• h: events of hash commands.

• z: events of sorted set commands.

• x: expiration events. Clients may be notified when an expired key is deleted instead of when a key expires.

• e: eviction events. Clients are notified when a key is evicted based on maxmemory policies.

• A: all the preceding event types. This parameter is the alias for the g$lshzxe parameter. Example: AKE.

Use intset encoding for sets that meet both conditions:

• when all data in the collection are character objects.

• All integers are base-10 and fit within the range of a 64-bit signed integer.

Maximum memory (in bytes) per macro node in a stream. Valid values: 0–999,999,999,999,999.

Maximum number of entries per macro node in a stream. Valid values: 0–999,999,999,999,999.

Maximum number of keys stored in the tracking table. Valid values: [0–1000000000]. Default: 1000000.

When a client's idle time reaches the specified number of seconds, the instance closes the connection. The unit is seconds. The range is [0,100000]. The default is 0, which means no connections are disconnected.

For instances compatible with Redis 6.0 and earlier, ziplist is the default codec for Zsets. A Zset uses ziplist encoding when both of the following conditions are met:

• The number of key-value pairs in the Zset is less than the value of zset-max-ziplist-entries.

• The string length of both the keys and values in the Zset's key-value pairs is less than the value of zset-max-ziplist-value.

For instances compatible with Redis 7.0 and later, listpack is the default codec for Zsets. A Zset uses listpack encoding when both of the following conditions are met:

• The number of key-value pairs in the Zset is less than the value of zset-max-listpack-entries.

• The string length of both the keys and values in the Zset's key-value pairs is less than the value of zset-max-listpack-value.

Specifies whether to pass the client's IP address through to the data node. Valid values:

• 0: Does not pass through. The IP addresses accessing the data nodes are all proxy node IP addresses.

• 1 (default): Passes through.

Enables or disables the Lua execution mode for read replicas. Valid values:

• 0 (default): Disables Lua execution mode. Read replicas do not support Lua. Lua commands are processed by the primary node.

• 1: Enables Lua execution mode. Only Lua scripts containing read operations are forwarded to read replicas for processing.

Enables or disables directional forwarding for requests from read-only accounts. Valid values:

• 0 (default): Disables directional forwarding. Requests from read-only accounts are distributed to all nodes, including the primary node, based on weight.

• 1: Enables directional forwarding. Requests from read-only accounts are forwarded directly to read replicas and not to the primary node.

The slow query log threshold for the proxy node. The unit is milliseconds (ms). The range is [30-2000]. The default is 500.

If the time from when a request is sent from the proxy node to a data node until the proxy node receives the response exceeds this threshold, a slow query log entry is generated.

Specifies whether to enable the Sentinel-compatible mode for cluster instances in proxy mode or read/write splitting instances. Valid values:

• 1: enables the Sentinel-compatible mode.

• 0 (default): disables the Sentinel-compatible mode.

Enables or disables the feature that converts SUBSCRIBE to PSUBSCRIBE. Valid values:

• 0 (default): Disables the feature. The two are not converted.

• 1: Enables the feature. The proxy node converts SUBSCRIBE to PSUBSCRIBE for processing.

  Note

  You can enable this feature if you cannot receive notifications on a subscribed channel because PUB or SUB class commands are used in a Lua script.