All Products
Search
Document Center

ApsaraDB for Redis:View endpoints

Last Updated:Mar 12, 2024

To connect to an ApsaraDB for Redis instance, you must obtain the endpoint of the Redis instance. The virtual IP address (VIP) of a Redis instance may change due to maintenance or configuration change. We recommend that you connect to a Redis instance by using an endpoint (such as r-2vcl6xcftp1nu7****.com) to ensure service availability. You can view different types of endpoints in the ApsaraDB for Redis console.

Prerequisites

The IP address of your client is added to a whitelist of the ApsaraDB for Redis instance. For more information, see Configure whitelists.

Procedure

  1. Log on to the ApsaraDB for Redis console and go to the Instances page. In the top navigation bar, select the region in which the instance that you want to manage resides. Then, find the instance and click the instance ID.

  2. In the Connection Information section, view different types of endpoints and port numbers.

    Note

    Then, you can connect to the ApsaraDB for Redis instance. For more information, see Use redis-cli to connect to an ApsaraDB for Redis instance.

Proxy mode and direct connection mode

ApsaraDB for Redis supports the following connection modes:

  • Proxy mode

    Clients connect to ApsaraDB for Redis instances by using proxy nodes.

    Proxy nodes are developed in-house to enable architecture changes, route commands, balance loads, perform failovers, and run in-house commands for Tair instances in proxy mode. The connection mode offers several advantages, including aggregated connections, enhanced read performance, and ease of use. This can help you design more efficient business systems. For more information, see Features of proxy nodes.

  • Direct connection mode

    For standard master-replica instances, clients directly connect to the master nodes of the instances.

    For ApsaraDB for Redis cluster instances, clients directly connect to the instances, and tasks such as load balancing are handled by the instances. This is exactly the same as the direct connection to native Redis clusters.

Supported network types and connection modes for instances of different architectures

In the following table, ️️✔️ indicates that the item is supported and ❌ indicates that the item is not supported.

Deployment mode

Architecture

Connection mode

VPC

Internet

Cloud disk-based

Standard architecture

Direct connection mode

✔️

✔️

Cluster architecture1

Direct connection mode

✔️

Proxy mode

✔️

✔️

Read/write splitting architecture

Proxy mode

✔️

✔️

Local disk-based

Standard architecture

Direct connection mode

✔️

✔️

Cluster architecture2

Proxy mode

Direct connection mode

✔️

✔️

Read/write splitting architecture

Proxy mode

✔️

✔️

Important

1Cloud disk-based cluster instances can only support either direct connection mode or proxy mode, but not both simultaneously.

2Local disk-based cluster instances can support both direct connection mode and proxy mode simultaneously.

VPC and Internet

Network types supported by ApsaraDB for Redis:

  • VPC

    A virtual private cloud (VPC) is a private network that is isolated from other networks at the network layer on top of physical-layer protocols. VPCs provide high security, reliability, flexibility, scalability, and ease of use. For more information, see What is a VPC?

    Scenario: An Elastic Compute Service (ECS) instance is deployed in the same VPC as your ApsaraDB for Redis instance, and the ECS instance can connect to your ApsaraDB for Redis instance over the VPC. This achieves higher security and lower network latency.

  • Internet

    For more information, see Apply for a public endpoint for an ApsaraDB for Redis instance.

    Although you are not charged for the traffic to connect to ApsaraDB for Redis instances over the Internet, the connection may incur risks. We recommend that you use a VPC to ensure higher security.

    Scenario: Your ApsaraDB for Redis instance can be connected over the Internet by using your on-premises device, an ECS instance deployed in a different VPC, or a device within a third-party cloud service.

FAQ

Why is the endpoint of an instance not displayed after I connect to the instance?

The endpoint of the or ApsaraDB for Redis instance is displayed only after you add the IP address of your client to a whitelist of the instance. For more information, see Configure whitelists.

Why am I unable to find the entry point to apply for a public endpoint for an instance?

No option is available to apply for a public endpoint due to two reasons:

  • If the VPC endpoint is not displayed in the Connection Information section, no whitelist is configured for the ApsaraDB for Redis instance. Configure a whitelist first. For more information, see Configure whitelists.

  • Public endpoints are not supported for ApsaraDB for Redis cloud-native cluster instances that run in direct connection mode. You can connect to these instances over a VPC.

    Note

    Check whether the instance is a cloud-native cluster instance that runs in direct connection mode. For more information, see How do I know whether an instance is a cloud-native cluster instance that runs in direct connection mode?

    If the Elastic Compute Service (ECS) instance where your application resides is not in the same VPC as the ApsaraDB for Redis instance, or if your application is not hosted on Alibaba Cloud, you can configure the cloud-native cluster instance to run in proxy mode. A cloud-native cluster instance cannot be directly switched from direct connection mode to proxy mode. You can use the instance restoration feature to migrate and reconfigure the setup. This involves restoring backup data from the source instance to a new instance and selecting Proxy as the connection mode in the process. For more information, see Restore data from a backup set to a new instance.

    Warning

    After the new cloud disk-based cluster instance is created with a new connection mode, modify the connection code accordingly. Otherwise, the instance cannot be connected. Proceed with caution.

How do I know whether an instance is a cloud disk-based cluster instance that runs in direct connection mode?

You can log on to the Tair console ApsaraDB for Redis console and go to the Instance Information page to check whether the instance is deployed in a cloud-native cluster architecture.

image

In the Connection Information section of the Instance Information page, check whether direct connection mode is used.

image

You cannot apply for a public endpoint for a cloud-native cluster instance that runs in direct connection mode. In the Connection Information section, the Apply for Endpoint button corresponding to Public Access is dimmed and cannot be clicked.

What do I do if the connection to an instance fails?

Am I able to connect to a replica node? Why am I unable to see the endpoint of a replica node?

The replica nodes of Tair and Redis instances are designed to provide redundancy and failover support, not to serve client traffic directly. They stand by to take over in case the master node fails, ensuring high availability. Therefore, you cannot directly connect to replica nodes.

References