Document Center
ApsaraDB for Redis
Release notes
Notices
2020 to present
Vulnerability CVE-2021-3711: Buffer overflow vulnerability of OpenSSL
Sales of ApsaraDB for Redis hybrid-storage instances are discontinued
Announcement: performance monitoring upgraded
[Notice] Official version of the audit log feature for ApsaraDB for Redis released
The DescribeMonitorItems operation supported by ApsaraDB for Redis is phased out
ApsaraDB for Redis 2.8 instances are phased out
API operations for cache analysis will be upgraded
Upgraded performance monitoring
Deprecated alarm metrics in Cloud Monitor
Early notification
Deprecated standalone instances
Product Introduction
What is ApsaraDB for Redis?
Overview and selection of ApsaraDB for Redis
Select ApsaraDB for Redis instances
Comparison between ApsaraDB for Redis and self-managed Redis
Comparison between ApsaraDB for Redis Enhanced Edition (Tair) and ApsaraDB for Redis Community Edition
Feature
Scenarios
Disaster recovery
ApsaraDB for Redis Enhanced Edition (Tair)
Overview
Performance-enhanced instances
Persistent memory-optimized instances
Storage-optimized instances
Hybrid-storage instances (phased out)
Integration of multiple Redis modules
Architectures
Overview
Standard master-replica instances
Cluster master-replica instances
Read/write splitting instances
Features of proxy servers
Instance specifications
Overview
Community Edition
Master-replica standard instances
Master-replica cluster instances
Read/write splitting instances
Enhanced Edition
Performance-enhanced standard instances
Performance-enhanced cluster instances
Performance-enhanced read/write splitting instances
Cloud Disk Enhanced Edition
Persistent memory-optimized instances
Storage-optimized instances
Phased-out specifications
Read/write splitting cluster instances (retired)
Hybrid-storage standard instances (retired)
Hybrid-storage cluster instances (retired)
Retired instance types
Commands
Overview
Commands supported by Community Edition
Commands supported by Enhanced Edition
Limits on commands supported by ApsaraDB for Redis Enhanced Edition (Tair)
New commands supported by performance-enhanced instances of ApsaraDB for Redis Enhanced Edition (Tair)
CAS and CAD commands
TairString commands
TairHash commands
TairGIS commands
TairBloom commands
TairDoc commands
TairZSET commands
Redis commands developed by Alibaba Cloud
Limits on commands supported by cluster instances
Limits on the commands supported by read/write splitting instances
Supported parameters
Version description
Features of ApsaraDB for Redis major versions
Feature updates of ApsaraDB for Redis 5.0
Features of ApsaraDB for Redis 4.0
Release notes of minor versions
ApsaraDB for Redis Enhanced Edition (Tair)
ApsaraDB for Redis Community Edition
ApsaraDB for Redis proxy nodes
Terms
Pricing
Billable items and prices
Billing method
Expiration, overdue payments, and renewal
Configuration change
Quick Start
Overview
Step 1: Create an ApsaraDB for Redis instance
Step 2: Configure whitelists
Connect to an ApsaraDB for Redis instance
Manage ApsaraDB for Redis instances
Data Migration And Synchronization
Migrate data
Overview
Migrate data from on-premises Redis to ApsaraDB for Redis
Migrate data from a self-managed Redis database to an ApsaraDB for Redis instance
Use redis-shake to migrate data from a self-managed Redis database to Alibaba Cloud
Use redis-shake to migrate the data of a self-managed Redis database from a backup file to an ApsaraDB for Redis instance
Use redis-shake to migrate data from on-premises Codis or Redis to ApsaraDB for Redis
Synchronize data from a Codis cluster hosted on ECS to an ApsaraDB for Redis instance
Synchronize data from Twemproxy Redis on ECS to ApsaraDB for Redis
Use AOF files to migrate data
Migrate data between ApsaraDB for Redis instances
Migrate data between ApsaraDB for Redis instances by using Redis-shake
Migrate data from a third-party database to ApsaraDB for Redis
Migrate data from an Amazon ElastiCache for Redis cluster to an ApsaraDB for Redis instance
Migrate data from SSDB to ApsaraDB for Redis
Migrate data from Google Cloud Memorystore for Redis to ApsaraDB for Redis
Verify data after migration
Data Synchronization
Overview
Synchronize data from on-premises Redis to ApsaraDB for Redis
Synchronize data from a user-created Redis cluster to an ApsaraDB for Redis cluster instance
Synchronize data from a self-managed Redis database hosted on ECS to an ApsaraDB for Redis instance
Synchronize data from a Codis cluster hosted on ECS to an ApsaraDB for Redis instance
Synchronize data from Twemproxy Redis on ECS to ApsaraDB for Redis
Use ssdb-port to synchronize data from SSDB to ApsaraDB for Redis
Synchronize data between ApsaraDB for Redis instances
Synchronize data in one direction between ApsaraDB for Redis instances
Configure two-way data synchronization between ApsaraDB for Redis Enterprise Edition instances
Synchronize data between ApsaraDB for Redis cluster instances across Alibaba Cloud accounts
FAQ about data migration and data synchronization
User Guide
Console logon
Limits
RAM-based access control
Service linked roles in ApsaraDB for Redis
Authorize RAM users to manage ApsaraDB for Redis instances by using system policies
Authorize RAM users to manage ApsaraDB for Redis instances by using custom policies
Manage events
Query history events
Query and manage pending events
FAQ about pending events
Subscribe to event notifications
Manage instances
Instance states and impacts
Lifecycle management
Lifecycle of an ApsaraDB for Redis instance
Change the configurations of an instance
Adjust the number of shards for an ApsaraDB for Redis instance
Restart an instance
Change the billing method to subscription
Renew an instance
Upgrade the major version
Update the minor version
Release instances
Manage ApsaraDB for Redis instances in the recycle bin
Manage bandwidth
Enable bandwidth auto scaling
Adjust the bandwidth of an ApsaraDB for Redis instance
Network connection management
Change the VPC or vSwitch of an ApsaraDB for Redis instance
Change the network type from classic network to VPC
Change the endpoint or port number of an ApsaraDB for Redis instance
Apply for a public endpoint
Release public endpoints
Enable the direct connection mode
Release a direct connection endpoint
Obtain the number of available IP addresses in the vSwitch where an ApsaraDB for Redis instance is deployed
Modify the expiration date of a classic network endpoint
Release a classic network endpoint
System Parameters
Modify the parameters of an ApsaraDB for Redis instance
Common Parameter Adjustment Cases
High availability
Causes and impacts of master-replica switchovers
Manually switch workloads from a master node to a replica node
Restart or rebuild a proxy server
Upgrade proxy servers
Tag management
Create a tag
Filter ApsaraDB for Redis instances by tag
View tags bound to an instance
Remove or delete a tag
Specify a maintenance window
Migrate an instance across zones
Export the instance list
Security management
Create and manage database accounts
Change or reset the password
Configure whitelists
Configure SSL encryption for an ApsaraDB for Redis instance
Enable TDE
Enable password-free access
Connection management
View endpoints
Use DMS
Use redis-cli to connect to an ApsaraDB for Redis instance
Use a client to connect to ApsaraDB for Redis
Connect to an ApsaraDB for Redis instance that has SSL encryption enabled by using a client
Use a private endpoint to connect to an ApsaraDB for Redis instance
Use the Sentinel-compatible mode to connect to ApsaraDB for Redis instances
Use a public endpoint to connect to an ApsaraDB for Redis instance
Connect an ECS instance to an ApsaraDB for Redis instance in different types of networks
Data management
Manage ApsaraDB for Redis instances by using DMS
Delete data
Performance monitoring
Monitoring metrics
Query monitoring data
Metrics
Customize metrics (previous version)
Modify the data collection interval (previous version)
Performance of queries
Performance trends
Add a performance trend chart
View performance metrics in real time
Instance sessions
Slow queries
Diagnose instances
Create a diagnostic report
Analyze a diagnostic report
Alert settings
Log management
Audit logs (new version)
Enable the new audit log feature
Query audit logs
Query historical hotkeys
Download audit logs
Subscribe to audit log reports
Query slow logs
Query active logs of an instance
Use slow logs to troubleshoot timeout issues
Backup and recovery
Backup and restoration solutions
Automatic or manual backup
Download backup files
Restore data from a backup set to a new instance
Restore data to a point in time by using the data flashback feature
Use redis-port to restore data
Use the redis-shake tool to back up data
Use redis-shake to restore data
FAQ
Product features
Which version of Redis is ApsaraDB for Redis compatible with?
What is the relationship between ApsaraDB for Redis and Redis?
Redis CSRF vulnerability analysis and security measures available for ApsaraDB for Redis
What commands and operations of ApsaraDB for Redis are compatible with Redis?
Does ApsaraDB for Redis support distributed cluster instances?
Can an ApsaraDB for Redis instance be configured with multiple replica nodes?
Does an ApsaraDB for Redis instance have limits on CPU processing capability, data transmission bandwidth, and the number of connections?
How many databases does a single ApsaraDB for Redis instance support?
Do all ApsaraDB for Redis instances have master and replica nodes?
Does ApsaraDB for Redis support read-only replica nodes?
Does ApsaraDB for Redis support failovers between master and replica nodes?
Database connections
How can I connect to an ApsaraDB for Redis instance by using redis-cli?
Do I need a password to connect to an ApsaraDB for Redis instance?
Do I need to install Redis on an ECS instance to use ApsaraDB for Redis?
Does ApsaraDB for Redis support Redis clients such as Jedis?
Can I upgrade or downgrade a subscription instance?
Using the database
Does ApsaraDB for Redis support Bloom filters?
What is the size of each database on an ApsaraDB for Redis instance, and how can I choose databases?
How can I import sample data to ApsaraDB for Redis?
Why do I receive an SMS message or email indicating that a failover is triggered?
Can I restore the deleted data of an ApsaraDB for Redis instance?
How can I monitor an ApsaraDB for Redis instance? Does the system automatically generate alerts when the capacity is reached?
Why is the memory usage of a new ApsaraDB for Redis instance not equal to 0?
Data persistence
Data persistence
Does ApsaraDB for Redis support data persistence?
Set parameters
Does ApsaraDB for Redis support changing configuration parameters?
Can I modify the REDIS_SHARED_INTEGERS parameter in ApsaraDB for Redis?
Expiration policy
How does ApsaraDB for Redis evict data by default?
Global Distributed Cache
Overview
Limits
Create a distributed instance
Add a child instance to a distributed instance
Release a distributed instance
Check the synchronization latency between child instances
Configure an alert rule to monitor the synchronization latency of child instances
Test the synchronization latency between child instances in different regions
Performance Troubleshooting And Tuning
Troubleshoot high CPU utilization on an ApsaraDB for Redis instance
Troubleshoot the high memory usage of an ApsaraDB for Redis instance
Troubleshoot high traffic usage on an ApsaraDB for Redis instance
Big keys and hotkeys
Use proxy query cache to address issues caused by hotkeys
Query big keys and hotkeys by using the key analysis feature
Use the cache analysis feature to display details about big keys
Best Practices
Development and O&M standards for ApsaraDB for Redis
Retry mechanisms for Redis clients
Support for Lua scripts and limits
Best Practices for Redis Enhanced Edition
Monitor user trajectories by using TairGIS
Implement high-performance distributed locks by using TairString
Concurrency control and optimistic locking
Bounded counter
Best Practices for All Editions
Migrate MySQL data to ApsaraDB for Redis
Rankings of online game players sorted by score
Correlation analysis on E-commerce store items
Publish and subscribe to messages
Pipeline
Process transactions
Discover and resolve the hotkey issue
ApsaraDB for Redis supports Double 11 Shopping Festival
Use ApsaraDB for Redis to build a business system that can handle flash sales
Read/write splitting in Redis
JedisPool optimization
Analyze hotkeys in a specific sub-node of a cluster instance
Use ApsaraDB for Redis to build a broadcasting channel information system
Parse AOFs
Query hotkeys in Redis 4.0
Analyze memory usage of ApsaraDB for Redis
Automatically add or remove ECS instances to or from a whitelist of an ApsaraDB for Redis instance
Performance White Paper
Master-replica cluster edition
Test environment
Test utility
Test command and metric
Test results
Performance-enhanced instances of ApsaraDB for Redis Enhanced Edition (Tair)
Test environment
Test utility
Test method
Test results
Persistent memory-optimized instances of ApsaraDB for Redis Enhanced Edition (Tair)
Test environment
Test tool
Test method
Test results
Storage-optimized instances of ApsaraDB for Redis Enhanced Edition (Tair)
Test environment
Test utility
Test method
Test results
API And SDK Reference
Quick start
API reference
Quick start to the ApsaraDB for Redis API
Make API requests
Call the ApsaraDB for Redis API by using Alibaba Cloud SDK for Java
Use Alibaba Cloud CLI to call API operations
Request and response structures
Request structure
Common parameters
Responses
Digital signature
RAM authentication
List of operations by function
Lifecycle management
DescribeRegions
DescribeZones
DescribeAvailableResource
CreateInstance
CreateInstances
Create a persistent memory-optimized or storage-optimized instance
ModifyInstanceSpec
ModifyNodeSpec
AddShardingNode
DeleteShardingNode
TransformToPrePaid
DeleteInstance
CreateGlobalDistributeCache
MigrateToOtherZone
Instance management
DescribeInstances
DescribeInstanceAttribute
DescribeGlobalDistributeCache
DescribeEngineVersion
DescribeRoleZoneInfo
DescribeClusterMemberInfo
DescribeTasks
DescribeDBInstanceNetInfo
EnableAdditionalBandwidth
ModifyInstanceAttribute
ModifyResourceGroup
DescribeLogicInstanceTopology
ModifyInstanceMaintainTime
ModifyInstanceMajorVersion
ModifyInstanceMinorVersion
RestartInstance
FlushExpireKeys
FlushInstance
SwitchInstanceHA
RemoveSubInstance
Connection management
SwitchNetwork
ModifyInstanceNetExpireTime
ModifyDBInstanceConnectionString
AllocateInstancePublicConnection
ReleaseInstancePublicConnection
AllocateDirectConnection
ReleaseDirectConnection
DescribeIntranetAttribute
Renewal Management
DescribePrice
RenewInstance
DescribeInstanceAutoRenewalAttribute
ModifyInstanceAutoRenewalAttribute
RenewAdditionalBandwidth
Account management
DescribeAccounts
CreateAccount
GrantAccountPrivilege
ModifyAccountDescription
ModifyAccountPassword
Reset a password
DeleteAccount
Backup and restoration
CreateBackup
DescribeBackupTasks
DescribeBackupPolicy
ModifyBackupPolicy
DescribeBackups
RestoreInstance
Monitoring management
DescribeMonitorItems
DescribeHistoryMonitorValues
Log management
ModifyAuditLogConfig
DescribeAuditLogConfig
DescribeAuditRecords
DescribeRunningLogRecords
DescribeSlowLogRecords
Network security
DescribeSecurityIps
ModifySecurityIps
DescribeSecurityGroupConfiguration
ModifySecurityGroupConfiguration
DescribeInstanceSSL
ModifyInstanceSSL
ModifyInstanceVpcAuthMode
TDE
ModifyInstanceTDE
DescribeInstanceTDEStatus
DescribeEncryptionKeyList
DescribeEncryptionKey
CheckCloudResourceAuthorized
Parameter Management
DescribeParameterTemplates
DescribeInstanceConfig
DescribeParameters
ModifyInstanceConfig
Tag management
ListTagResources
TagResources
UntagResources
Troubleshooting
Cache analysis and key analysis
CreateCacheAnalysisTask
DescribeCacheAnalysisReport
DescribeCacheAnalysisReportList
O&M task management
DescribeActiveOperationTask
ModifyActiveOperationTask
Additional description of parameters
Instance types
Description of the Instances parameter
MonitorKeys
API error center
Description of the Instances parameter in the DescribePrice API operation
SDK reference
Quick start to the ApsaraDB for Redis SDK
OpenAPI SDKs
Redis SDKs
FAQ
all-products-head
This Product
This Product
All Products
All Products
Show more
Show less