ApsaraDB for Redis provides multiple endpoint types and allows you to connect to an instance over a Virtual Private Cloud (VPC) or the Internet. You can connect to an instance by using Data Management (DMS), redis-cli, or a client.
Endpoint types
By default, you can connect to a ApsaraDB for Redis instance over a VPC. If you want to connect to your ApsaraDB for Redis instance from your on-premises device or other devices over the Internet, apply for a public endpoint for the ApsaraDB for Redis instance.ApsaraDB for Redis
If your client is deployed on an ECS instance in the same VPC as your ApsaraDB for Redis instance, we recommend that you connect to the ApsaraDB for Redis instance over the VPC by using a private endpoint. This improves security and reduces network latency.ApsaraDB for Redis
If your client is deployed on an on-premises device or an ECS instance that resides in a different region and a different VPC from your ApsaraDB for Redis instance, you can connect to the ApsaraDB for Redis instance over the Internet by using a public endpoint. Otherwise, you fail to connect to the ApsaraDB for Redis instance.ApsaraDB for Redis
Prerequisites
The public IP address of your client is added to a whitelist of the ApsaraDB for Redis instance.
Before you can connect to your ApsaraDB for Redis instance over a VPC or the Internet, you must add the IP address or CIDR block of your client to a whitelist of the ApsaraDB for Redis instance. For more information, see Step 2: Configure whitelists.
The username and password of an account are set to connect to the ApsaraDB for Redis instance.
You can connect to your ApsaraDB for Redis instance by using a default or custom account. For more information, see Logon methods.
Procedure
In this example, redis-cli is used to establish a connection between an Elastic Compute Service (ECS) instance that runs on the Linux operating system and an ApsaraDB for Redis instance over a VPC.
Log on to the ECS instance. Then, download and install redis-cli.
Run the following command to install GCC.
sudo yum -y install gcc
Run the following command to download the Redis source code package.
wget https://download.redis.io/releases/redis-7.0.0.tar.gz
NoteIn this example, Redis 7.0.0 is used to demonstrate the operations. You can install other versions. For more information, visit the Redis official website.
Run the following command to decompress the Redis source code package.
tar xzf redis-7.0.0.tar.gz
Run the following command to go to the directory to which the Redis source code package is decompressed. Then, compile and install redis-cli.
cd redis-7.0.0&&make
It takes 2 or 3 minutes to compile and install Redis.
Run the following command to go to the src directory and prepare to connect to the instance.
cd src
Obtain the connection information and run the following command in redis-cli to connect to the ApsaraDB for Redis instance.
./redis-cli -h hostname -p port [-c]
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 endpoint of the instance in the VPC.
If you connect to the ApsaraDB for Redis instance over the Internet, obtain the public endpoint of the instance.
For more information, see View endpoints.
port
The port number of the ApsaraDB for Redis instance.
The default port number is 6379.
-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.
Examples:
The following sample command is suitable for scenarios where Tair 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 where Tair 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. For example, if the username of the default account is
r-bp1zxszhcgatnx****
and the password isPassword21
, the command to verify the password isAUTH Password21
.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
, the command to verify the password isAUTH testaccount:Rp829dlwa
.
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 you use a third-party database management tool such as RDM to connect to your ApsaraDB for Redis instance, specify
user:password
as the password and leave the username field empty. Otherwise, you fail to connect to the instance.If password-free access is enabled for your ApsaraDB for Redis instance, you can run ApsaraDB for Redis commands without performing this step when you connect to the instance over a VPC.
Example:
AUTH testaccount:Rp829dlwa
If
OK
is returned, you succeed in connecting to the ApsaraDB for Redis instance and you can run ApsaraDB for Redis commands.
Common connection methods
Client | Recommended network type | Description |
DMS | VPC | |
ECS instance in the same VPC as the ApsaraDB for Redis instance | VPC | |
| Internet |
Special connection methods
Connect to an instance that has TLS (SSL) encryption enabled by using a client: TSL encryption improves transport link security and ensures data integrity.
Use a private endpoint to connect to an ApsaraDB for Redis instance: If your instance is a ApsaraDB for Redis cluster instance, you can use a private endpoint to bypass proxy nodes and directly access backend data shards. This connection to cluster instances is similar to the connection to open source Redis clusters. 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 proxy servers.
Use the Sentinel-compatible mode to connect to an ApsaraDB for Redis instance: ApsaraDB for Redis provides the Sentinel-compatible mode. After you enable this mode, ApsaraDB for Redis instances can be connected from the client in the same manner as the native Redis Sentinel.
Common errors and troubleshooting
Error message | Cause and solution |
| The whitelist is incorrectly configured.
Then, run the |
| |
| |
| The password is invalid. Specify the correct password in a valid format. The password format varies with the account type.
Note
|