redis-cli is a built-in CLI of open source Redis. You can use redis-cli to connect to and manage an ApsaraDB for Redis instance from an Elastic Compute Service (ECS) instance or on-premises device. This topic describes how to install and use redis-cli to connect to an ApsaraDB for Redis instance, and how to troubleshoot common connection errors.
Workflow
Step 1: Install redis-cli
Step 2: Use redis-cli to connect to the ApsaraDB for Redis instance
Go to the directory in which redis-cli is installed.
Windows: Open the CLI and go to the directory in which redis-cli is installed.
Linux: Go to the Redis directory that is suffixed with src. Example:
cd /home/redis-7.0.0/src
.
Run the following command to use redis-cli to connect to the ApsaraDB for Redis instance:
./redis-cli -h hostname -p port [-c]
NoteIf you want to start redis-cli in Windows PowerShell, run the
.\redis-cli -h hostname -p port [-c]
command.Table 1. Parameters Parameter
Description
Method to obtain the parameter value
hostname
The endpoint of the ApsaraDB for Redis instance.
If you connect to the ApsaraDB for Redis instance over a VPC, obtain the VPC endpoint of the ApsaraDB for Redis instance.
If you connect to the ApsaraDB for Redis instance over the Internet, obtain the public endpoint of the ApsaraDB for Redis instance.
For more information, see View endpoints.
port
The port number of the ApsaraDB for Redis instance.
Use the default port number 6379 or specify a custom port number. For more information, see Change the endpoint or port number of an instance.
-c
Specifies whether to enable the cluster mode.
The cluster mode is available only if the ApsaraDB for Redis instance is a cluster instance that uses a private endpoint. For more information, see Cluster master-replica instances and Enable the direct connection mode.
Connection examples:
The following sample command is suitable for scenarios in which ApsaraDB for Redis instances are connected by using default endpoints, such as endpoints of standard instances and proxy endpoints of cluster instances:
./redis-cli -h r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com -p 6379
The following sample command is suitable for scenarios in which ApsaraDB for Redis cluster instances are connected by using private endpoints:
./redis-cli -h r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com -p 6379 -c
Run the following command to verify the password:
AUTH password
Table 2. Parameters Parameter
Description
password
The password of the account.
If you use the default account whose username is the same as the instance ID, enter the password.
If you use a custom account, enter the password in the
user:password
format. For example, if the username of the custom account istestaccount
and the password isRp829dlwa
, entertestaccount:Rp829dlwa
as the password.
NoteIf you forget your password, reset the password. If you have not set the password, set the password. For more information, see Change or reset the password.
If password-free access is enabled for the ApsaraDB for Redis instance, you can run Redis commands without performing this step when you connect to the instance over a VPC. For more information, see Enable password-free access.
Example:
AUTH testaccount:Rp829dlwa
If
OK
is displayed, the ApsaraDB for Redis instance is connected and Redis commands can be run on the instance.For information about what to do if an error occurs, see the Common errors and troubleshooting section of this topic.
For information about the commands supported by ApsaraDB for Redis, see Overview.
Common errors and troubleshooting
If the minor version of your instance is outdated, the returned error messages may be inconsistent with those listed in the following table. We recommend that you update your instance to the latest minor version. For more information, see Update the minor version of an instance.
Error message | Cause and solution |
| A whitelist is not configured as required. For more information, see the Workflow section of this topic. |
| |
| The password is invalid. Specify the correct password in a valid format. The password format varies based on the selected account.
Note
|