ApsaraDB for Redis allows you to modify specific instance parameters. The instance parameters that can be modified vary with the engine version and instance architecture. This topic describes how to modify instance parameters.
Precautions
- If the
Parameter is not supported for current version
error appears when you configure parameters, update the minor version of your instance. For more information, see Update the minor version. - After you submit the modifications for specific parameters, your instance is automatically restarted. The instance experiences transient connections that last for a few seconds during the restart. On the page for modifying parameters in the Tair console, the Restart and Take Effect column indicates whether the instance must be restarted for the modification to take effect. For more information, see Modify the values of parameters for an instance.
Supported parameters and descriptions
The following items describe the symbols that are used in the tables of this topic:
- The ️️✔️ symbol indicates that the major version or instance architecture supports the parameter.
- The ❌ symbol indicates that the major version or instance architecture does not support the parameter.
- To ensure the stability of ApsaraDB for Redis instances, only specific parameters can be set. The parameters that are not described in this topic cannot be set.
- For more information about instance architectures, see Standard master-replica instances, Cluster master-replica instances, and Read/write splitting instances.
Parameter | Description | Major version and instance architecture | |||
---|---|---|---|---|---|
Redis 6.0 | Redis 5.0 | Redis 4.0 | Redis 2.8 | ||
#no_loose_audit-read-enabled | Specifies whether to enable read request audit. After you enable this feature, you can view information about read requests in the audit logs. For more information about audit logs, see Enable the new audit log feature. Default value: no. Valid values:
Note This parameter is unavailable for instances that use cloud disks. | ❌ | Standard❌ Cluster✔️ Read/write splitting✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️️️✔️ |
#no_loose_check-whitelist-always | Specifies whether to check that the IP address of a client is added to a whitelist of your ApsaraDB for Redis instance after password-free access is enabled for the instance. The client is deployed in the same VPC as the instance. Default value: no. Valid values:
Note This parameter is unavailable for instances that use cloud disks. | ❌ | Standard ️️️✔️ Cluster ️️️✔️ Read/write splitting ️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️✔️ Read/write splitting ️️️️✔️ | ❌ |
#no_loose_disabled-commands | Disables 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. Note
| Standard ️️️✔️ Cluster ️️️✔️ Read/write splitting ✔️ | Standard ️️️✔️ Cluster ️️️✔️ Read/write splitting ️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️✔️ Read/write splitting ️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️✔️ Read/write splitting ️️️️✔️ |
sentinel_compat_enable | Specifies whether to enable the Sentinel-compatible mode for read/write splitting instances and cluster instances in proxy mode. Default value: 0. Valid values:
| Cluster ✔️ Read/write splitting ✔️ | Cluster ✔️ Read/write splitting ✔️ | Cluster ✔️ Read/write splitting ✔️ | ❌ |
#no_loose_sentinel-enabled | Specifies whether to enable the Sentinel-compatible mode for standard instances and cluster instances in direct connection mode. Default value: no. Valid values:
| Standard ️️️✔️ Cluster ️️️✔️ | Standard ️️️✔️ Cluster ️️️✔️ | Standard ️️️✔️ Cluster ️️️✔️ | ❌ |
#no_loose_ssl-enabled | Specifies whether to enable SSL encryption. Default value: no. Valid values:
Note This parameter is unavailable for instances that use cloud disks. | ❌ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️️✔️ |
#no_loose_statistics-cmds | This parameter is related to the observability of ApsaraDB for Redis. After you specify this parameter for an instance, you must also enable the audit log feature for the instance. Audit logs are collected at an interval of 5 seconds.
Note
| ❌ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️️✔️ |
#no_loose_statistics-ip-enable | ❌ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️️✔️ | |
#no_loose_statistics-keys | ❌ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️️✔️ | |
#no_loose_tls-min-version | Specifies the earliest Transport Layer Security (TLS) version supported by the instance. Default value: TLSv1. Valid values:
| ❌ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️️✔️ |
cluster_compat_enable | Specifies whether to enable the support for the syntax of native Redis clusters for read/write splitting instances and cluster instances in proxy mode. Default value: 1. Valid values:
| ❌ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️️✔️ |
max_session_processing | Specifies the maximum number of pending requests that are allowed per connection. If a proxy node forwards requests from a client to a data node but does not receive a response from the data node, these requests are pending. This parameter is used to limit the number of pending requests that are caused by capability differences between the frontend and backend of proxy nodes. This prevents an increase in memory usage. | ❌ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️️✔️ |
ptod_enabled | Specifies whether to pass through client IP addresses to data nodes by using proxy nodes. Default value: 0. Valid values:
Note This parameter is irrelevant to instances that use the standard architecture or instances that use the cluster architecture and have the direct connection mode enabled. | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️✔️ | Standard ❌ Cluster ✔️ Read/write splitting ️️️️✔️ | ❌ |
readonly_lua_route_ronode_enable | Specifies whether to enable Lua scripting on read replicas. Default value: 0. Valid values:
| ❌ | Standard ❌ Cluster ❌ Read/write splitting ️️️✔️ | Standard ❌ Cluster ❌ Read/write splitting ️️️️✔️ | ❌ |
read_request_only_ronode_whenrwsplit_enable | Specifies whether to enable unidirectional forwarding for requests from accounts that have read-only permissions. Default value: 0. Valid values:
| ❌ | Standard ❌ Cluster ❌ Read/write splitting ️️️✔️ | Standard ❌ Cluster ❌ Read/write splitting ️️️✔️ | Standard ❌ Cluster ❌ Read/write splitting ️️️️✔️ |
rt_threshold_ms | Specifies the threshold to log slow queries of a proxy node. Unit: milliseconds. If the proxy node processes a request for a period of time longer than the specified threshold, the request is recorded in a slow log. Note This period of time starts when the proxy node sends a request to a data node and ends when the proxy node receives the response. | ❌ | Standard ❌ Cluster ️️️️✔️ Read/write splitting ️️✔️ | Standard ❌ Cluster ️️️️✔️ Read/write splitting ️️✔️ | Standard ❌ Cluster ️️️️✔️ Read/write splitting ️️✔️ |
script_check_enable | Specifies whether to check that the keys used in Lua scripts are mapped to the same slot. Default value: 1. Valid values:
| ❌ | Standard ❌ Cluster ️️️️✔️ Read/write splitting ️️✔️ | Standard ❌ Cluster ️️️️✔️ Read/write splitting ️️✔️ | Standard ❌ Cluster ️️️️✔️ Read/write splitting ️️✔️ |
transfer_subscrible_to_psubscrible_enable | Specifies whether to enable the feature of converting SUBSCRIBE to PSUBSCRIBE. Default value: 0. Valid values:
| ❌ | Standard ❌ Cluster ️️️️✔️ Read/write splitting ️️✔️ | Standard ❌ Cluster ️️️️✔️ Read/write splitting ️️✔️ | ❌ |
appendfsync | Specifies the frequency to perform fsync operations of append-only file (AOF) persistence. The default value is everysec and cannot be changed. This parameter is available only if the appendonly parameter is set to yes. | Standard ️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
appendonly | Specifies whether to enable append-only file (AOF) persistence for master nodes. Default value: yes. Valid values:
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
client-output-buffer-limit pubsub | Specifies the output buffer limits of publisher and subscriber clients. The clients are disconnected when the specified limits are reached. Specify a value for this parameter in the following format: <hard limit> <soft limit> <soft seconds> . Default value: 33554432 8388608 60.
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
dynamic-hz | Specifies whether to enable dynamic frequency control for background tasks. Default value: yes. Valid values:
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ❌ Read/write splitting ❌ | ❌ | ❌ |
hash-max-ziplist-entries | Specifies the maximum number of key-value pairs stored in a hash. Ziplist encoding is used only if both of the following conditions are met:
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
hash-max-ziplist-value | Specifies the maximum size of the keys and values of key-value pairs stored in a hash. Ziplist encoding is used only if both of the following conditions are met:
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
hz | Specifies how frequently tasks are performed in the background. For example, you can specify how frequently tasks are performed to evict expired keys. Valid values: 1 to 500. The default value is 10, which specifies that each task is performed 10 times per second. Note A greater value results in higher CPU utilization but allows ApsaraDB for Redis to delete expired keys more frequently and close timeout connections more precisely. We recommend that you specify a value less than or equal to 100. | Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
lazyfree-lazy-eviction | Specifies whether to enable the eviction feature based on the lazyfree mechanism. Default value: no. Valid values:
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ | ❌ |
lazyfree-lazy-expire | Specifies whether to delete expired keys based on the lazyfree mechanism. Default value: yes. Valid values:
| Standard ️️️️️️️✔️ Cluster ️️️️️️️️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ | ❌ |
lazyfree-lazy-server-del | Specifies whether to asynchronously delete data based on the lazyfree mechanism for an implicit DEL operation. Default value: yes. Valid values:
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ | ❌ |
lazyfree-lazy-user-del | Specifies whether to asynchronously delete data based on the lazyfree mechanism when a user runs the DEL command. Default value: yes. Valid values:
| Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ✔️ | ❌ | ❌ | ❌ |
list-compress-depth | Specifies the number of nodes that are not compressed at both ends of a list. Default value: 0. Valid values: 0 to 65535.
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ | ❌ |
list-max-ziplist-entries | Specifies the maximum number of elements stored in a list. Ziplist encoding is used only if both of the following conditions are met:
| ❌ | ❌ | ❌ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
list-max-ziplist-value | Specifies the maximum size of the elements stored in a list. Ziplist encoding is used only if both of the following conditions are met:
| ❌ | ❌ | ❌ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
list-max-ziplist-size |
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ | ❌ |
maxmemory-policy | Specifies the policy used to evict keys if memory is exhausted. If the memory usage of your ApsaraDB for Redis instance reaches the value of Maxmemory, data eviction is triggered. You can choose a data eviction policy based on your needs. Valid values: Note
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
notify-keyspace-events | Specifies 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.
Important The specified value must include at least K or E. Otherwise, no notifications are sent. For example, if you want to be notified of expiration events, set this parameter to | Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
set-max-intset-entries | Specifies the maximum number of data entries for which a set supports intset encoding. A set uses intset encoding when the following conditions are met:
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
slowlog-log-slower-than | Specifies the threshold to log slow queries. When an operation is executed for a period of time that exceeds the specified threshold, the operation is logged. Unit: microseconds. Valid values: 10000 to 10000000. Default value: 20000. | Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
slowlog-max-len | Specifies the maximum number of entries that can be stored in a slow log. Valid values: 100 to 10000. Default value: 1024. | Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
stream-node-max-bytes | Specifies the maximum amount of memory that each macro node in a stream can occupy. Valid values: 0 to 999999999999999. Unit: bytes. Note A value of 0 indicates that no limits exist. | Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ❌ Read/write splitting ❌ | ❌ | ❌ |
stream-node-max-entries | Specifies the maximum number of entries that can be stored on each macro node in a stream. Valid values: 0 to 999999999999999. Note A value of 0 indicates that no limits exist. | Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ❌ Read/write splitting ❌ | ❌ | ❌ |
timeout | Specifies a timeout period. The system closes a connection to a client if the connection remains idle for the specified period of time. Valid values: 0 to 100000. Unit: seconds. Note A value of 0 indicates that no timeout periods are specified. | Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ | ❌ |
zset-max-ziplist-entries | Specify the maximum number of key-value pairs stored in a sorted set and the maximum size of the keys and values of key-value pairs stored in the sorted set. Ziplist encoding is used only if the following conditions are met:
| Standard ️️️️️️️✔️ Cluster ️️✔️ Read/write splitting ✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️️️️️️️✔️ | Standard ️️️️️️️✔️ Cluster ️️️️️️️️✔️ Read/write splitting ️️✔️ |
zset-max-ziplist-value |