You can manage ApsaraDB for Redis instances in a convenient manner by using the ApsaraDB for Redis console, API operations, or SDKs.

Management modes

Management mode Description
ApsaraDB for Redis console The ApsaraDB for Redis console is a web application that is used to manage ApsaraDB for Redis instances. It provides various O&M and management features to help you manage instances in a convenient and visualized manner.
API ApsaraDB for Redis supports various API operations. All operations that can be performed by using the console are supported by API operations. For more information about API operations, see List of operations by function.
SDK An SDK is a set of programs and software tools that can be used to call API operations and implement various features. For more information, see Usage notes for Alibaba Cloud SDK for Java.

User guide for the ApsaraDB for Redis console

Click a tab to show the details. Click again to hide the details.

Operation Description
Overview of data migration solutions ApsaraDB for Redis provides multiple solutions for data migration. These solutions use Data Transmission Service (DTS) and redis-shake. The solutions allow you to migrate data in different scenarios based on your business requirements.
Overview of data synchronization solutions ApsaraDB for Redis provides multiple solutions for data synchronization. These solutions use Data Transmission Service (DTS) and redis-shake. The solutions apply to the following scenarios: data synchronization between on-premises Redis databases and Alibaba Cloud services, active geo-redundancy, disaster recovery, and data analytics.
FAQ about data migration and data synchronization The topic provides answers to some frequently asked questions (FAQ) about data migration and data synchronization, such as what the differences are, how different solutions work, and how to troubleshoot issues.
Operation Description
Query and manage pending events You can receive notifications for events such as instance migrations and version upgrades by phone calls, emails, internal messages, and console notifications. You can view event types, regions, precautions, and related instances. You can also change the scheduled switchover time.
Subscribe to event notifications ApsaraDB for Redis is integrated with CloudMonitor. You can configure alert rules for ApsaraDB for Redis in the CloudMonitor console. Alerts are immediately generated after the specified thresholds are exceeded or events are detected. This allows you to make informed business decisions.
Category Operation Description
Manage lifecycles Lifecycle of an ApsaraDB for Redis instance The lifecycle of an ApsaraDB for Redis instance starts when the instance is created and ends when the instance is released. A lifecycle contains stages such as specification changes, major version upgrades, minor version upgrades and restarts.
Manage network connections Change the VPC or vSwitch of an ApsaraDB for Redis instance You can change the virtual private cloud (VPC) or vSwitch in which an ApsaraDB for Redis instance is deployed. For example, you can change the VPC of an ApsaraDB for Redis instance to the VPC to which an Elastic Compute Service (ECS) instance belongs. This way, the ApsaraDB for Redis instance can communicate with the ECS instance.
Change the network type from classic network to VPC You can switch the network type of an ApsaraDB for Redis instance from classic network to VPC. Then, clients can communicate with the ApsaraDB for Redis instance within the same VPC. This ensures higher security and lower network latency.
Modify endpoints and ports You can modify the endpoints and ports of ApsaraDB for Redis instances. For example, you can modify ports to improve the security of connections. You can also modify the endpoint of a new instance to the endpoint of the original instance. This way, you do not modify the connection information on your application.
Apply for a public endpoint By default, ApsaraDB for Redis provides an internal endpoint. To access an ApsaraDB for Redis instance over the Internet, you must apply for a public endpoint.
Enable the direct connection mode You can apply for a direct connection endpoint for a cluster instance and use the endpoint to directly access backend data shards. This connection method is similar to the method used to connect to a Redis-native cluster. Compared with the proxy mode, the direct connection mode reduces the response time of ApsaraDB for Redis because requests do not need to pass through a proxy server.
Manage instance parameters Parameter overview ApsaraDB for Redis allows you to specify values for specific parameters based on your business requirements. The parameters that are supported vary based on engine version and architecture.
Manage nodes Switch node roles ApsaraDB for Redis supports automatic failovers from the master node to the replica node. You can also manually switch workloads from the master node to the replica node. This allows you to perform real-time disaster recovery drills. You can switch the node roles for an instance that is deployed across multiple zones based on your business deployment. This way, your applications can connect to the nearest nodes.
Restart or rebuild a proxy node ApsaraDB for Redis allows you to restart or rebuild a proxy node. This way, you can perform real-time disaster recovery drills. You can also perform O&M tasks when the service is unavailable or a high latency occurs.
Upgrade a proxy node ApsaraDB for Redis allows you upgrade a proxy node to use the latest features.
Manage tags Create a tag When you have a large number of instances, you can create and add multiple tags to classify and filter instances by tag.
Filter ApsaraDB for Redis instances by tag After you add tags to ApsaraDB for Redis instances, you can filter ApsaraDB for Redis instances by tag in the instance list to manage instances of a specific category.
Other operations Migrate an instance across zones If the current zone in which your instance is deployed has insufficient resources for a specification upgrade or you want to improve the disaster recovery capability, you can migrate the instance to another zone.
Set the maintenance window You can set the maintenance window to off-peak hours of your business and perform O&M operations such as specification changes during the maintenance window. This way, you can avoid impacts on business caused by transient connections.
Operation Description
Create and manage accounts ApsaraDB for Redis allows you to create multiple accounts for an instance. You can grant these accounts different permissions, such as the read-only, read/write, or copy permissions. This helps you flexibly manage instances, minimize user errors, and improve data security.
Change or reset the password If you forget your password, want to change your password, or do not set a password for an instance, you can set a new password for the instance.
Set IP address whitelists To connect to an instance by using a client, you must add the IP address of the client to the whitelist of the instance. Proper use and management of whitelists ensure secure access to instances.
Configure SSL encryption To enhance data transmission security, you can enable secure sockets layer (SSL) encryption for your instances and install SSL certificates that are issued by certificate authorities (CAs) to your applications. SSL encryption can encrypt network connections at the transport layer. This improves data security and ensures data integrity.
Enable password-free access for a VPC To enable password-free access, make sure that the client and the ApsaraDB for Redis instance are deployed within the same VPC. This way, the client can access the ApsaraDB for Redis instance without the need to use a password. After password-free access is enabled, you can still use a username and a password to connect to the ApsaraDB for Redis instance.
Operation Description
Overview of connection methods ApsaraDB for Redis supports different types of endpoints. You can connect to an ApsaraDB for Redis instance by using clients, Data Management (DMS), or redis-cli.
Manage ApsaraDB for Redis instances by using DMS Data Management (DMS) provides multiple extended features and allows you to manage ApsaraDB for Redis instances by using commands or interfaces.
Category Operation Description
Metric Query monitoring data ApsaraDB for Redis supports various performance metrics. You can query the monitoring data of an ApsaraDB for Redis instance during a specified period of time in the previous month. This allows you to gain insights into the status of the ApsaraDB for Redis instance and troubleshoot issues at the earliest opportunity.
Understand metrics This topic describes the metrics that are collected in real time to monitor the status of ApsaraDB for Redis instances and the limits of these metrics in use.
Query performance data Query performance trends ApsaraDB for Redis allows you to query the performance trends of an instance during a specified period of time. The performance trends include the CPU utilization, memory usage, queries per second (QPS), total connections, response time, data transfer, and key hit ratio.
View real-time performance metrics ApsaraDB for Redis allows you to view the performance metrics of instances in real time. The performance metrics include information about CPU utilization, memory usage, queries per second (QPS), network traffic, servers, keys, clients, and connections.
Manage sessions This feature allows you to view real-time information about sessions between a Redis instance and a client, including the client information, commands that are run, and the connection duration. You can also close abnormal sessions based on business requirements.
View slow query logs Slow queries decrease the stability of ApsaraDB for Redis instances. You can monitor and analyze slow queries by using slow query logs.
Identify big keys The cache analytics feature can analyze backup files of ApsaraDB for Redis and find big keys on your instances. This feature allows you to view the information about an instance, such as the memory usage, distribution, and expiration time of keys. You can optimize your instances based on the analytic results. This feature helps you resolve issues such as insufficient memory and performance degradation that are caused by the skewed distribution of keys.
Query hotkeys in real time On an ApsaraDB for Redis instance, the keys that are frequently accessed are called hotkeys. Improper management of hotkeys may cause congestion and degrade service performance. ApsaraDB for Redis allows you to query hotkeys on an instance in real time.
Diagnose instances Create a diagnostic report You can use the diagnostics feature to create a diagnostic report for an ApsaraDB for Redis instance within a specified period of time. Diagnostic reports help you evaluate the status of an ApsaraDB for Redis instance, such as performance level, skewed requests distribution, and slow query logs. Diagnostic reports also help you identify anomalies on an instance.
Configure alert rules Configure alert rules for monitored metrics ApsaraDB for Redis is integrated with CloudMonitor. You can configure alert rules for ApsaraDB for Redis in the CloudMonitor console. Alerts are immediately generated after the specified thresholds are exceeded or exceptions are detected. This allows you to troubleshoot issues in a timely manner.
Operation Description
Enable audit logs To improve user experience, Alibaba Cloud has released a new version of the audit log feature for ApsaraDB for Redis. The audit log feature integrates Log Service to provide insights into service security and performance. You can use this feature to query, analyze, and export log data.
Query audit logs You can query audit logs in a specified time range and filter audit logs that match specified conditions.
Analyze slow query logs Issues such as connection timeouts that are caused by slow queries degrade service performance. The slow query log feature of ApsaraDB for Redis allows you to find the IP addresses of clients that send the query requests and troubleshoot issues.
Query operational logs You can query operational logs within 72 hours and troubleshoot O&M issues based on the logs.
Operation Description
Backup and restoration solutions ApsaraDB for Redis offers high performance, high security, and high availability. In addition, this service uses diverse architectures. An increasing number of applications use ApsaraDB for Redis as the database engine for persistent storage. ApsaraDB for Redis provides a variety of solutions that allow you to back up or restore data in different scenarios.
Operation Description
Troubleshoot performance issues This topic describes how to troubleshoot performance issues and introduces some solutions. High CPU utilization, high memory usage, and high bandwidth usage issues are used as examples.
FAQ This topic provides answers to some frequently asked questions (FAQ) about the features, usage, connection methods, data persistence mechanisms, and parameters of ApsaraDB for Redis.