Use redis-cli - Quick Start| Alibaba Cloud Documentation Center

Introduction to redis-cli

Redis-cli is a command-line tool included in the Redis software distribution. You can use redis-cli to connect to an ApsaraDB for Redis instance and send commands to the instance to manage data.

With redis-cli, you can connect to an ApsaraDB for Redis instance from an ECS instance running Linux through the Alibaba Cloud intranet, or from a local host through the Internet. Accessing ApsaraDB for Redis through the Alibaba Cloud intranet provides higher security and performance. To access an ApsaraDB for Redis instance from a local host through the public network, you must follow the instructions in Through the Internet to apply for a public endpoint. Then, you can follow the instructions in the How to connect section of this topic to connect to the instance.

Install redis-cli

Install the Redis software distribution that includes redis-cli in Linux. For more information, see Redis community.

Prerequisites

Connect through the Alibaba Cloud intranet

If the network type for both the ECS instance and the ApsaraDB for Redis instance is VPC, the two instances must reside in the same VPC of a region.
If the network type for both the ECS instance and the ApsaraDB for Redis instance is classic network, the two instances must reside in the same region.
You have added the private IP address of an ECS instance to the whitelist of an ApsaraDB for Redis instance.
You have installed the Redis software distribution on the ECS instance.
If you use a customized account to log in the Redis instance, the format of the connection password is <user>:<password>. For example, if the username of your accout is admin, and its password is Rp829dlwa, when logging in the Redis instance, use admin:Rp829dlwa as the connection password.

Connect through the Internet

The ApsaraDB for Redis instance has a public endpoint. For more information, see Through the Internet.
You have added the public IP address of the local host to a whitelist of the ApsaraDB for Redis instance.
The operating system of the local host must be Linux.
You have installed the Redis software distribution on the local host.
If you use a customized account to log in the Redis instance, the format of the connection password is <user>:<password>. For example, if the username of your accout is admin, and its password is Rp829dlwa, when logging in the Redis instance, use admin:Rp829dlwa as the connection password.

Precautions

If you access an ApsaraDB for Redis instance from its private endpoint with the VPC password-free access feature enabled, you can access the instance without a password.
If you access an ApsaraDB for Redis instance from its public endpoint with the VPC password-free access feature enabled, a password is still required for accessing the instance.
For more information about how to fix errors that may occur when you connect to an ApsaraDB for Redis instance, see Troubleshooting for connection issues in ApsaraDB for Redis.

How to connect

You can use the following command to connect to an ApsaraDB for Redis instance.

redis-cli -h <host> -p <port> -a <password>

Table 1. Parameters
Name	Description
-h	Specifies the endpoint of the ApsaraDB for Redis instance. Access an ApsaraDB for Redis instance through the Alibaba Cloud intranet, use an private endpoint. Access an ApsaraDB for Redis instance through the Internet, use a public endpoint.
-p	Specifies the service port of the ApsaraDB for Redis instance. The default port number is 6379. You cannot change the port number.
-a	Set the password for the ApsaraDB for Redis instance. You can skip this parameter to avoid displaying a password in plain text to enhance security. After running the preceding command, you can enter `auth <password>` to complete the authentication. The following figure shows an example.