This topic describes how to configure the global endpoint for primary and standby instances across different cloud providers.
Background information
A global endpoint is a single connection endpoint that can be used to access both primary and standby instances. This configuration enables automatic request routing to the standby instance during primary instance failures without requiring connection string modifications in your applications. This minimizes application-level changes for connection management and ensures high availability of your business.
Global Endpoint: A virtual connection endpoint that clients use to access the instance. The system automatically routes requests to the appropriate instance based on the current primary-standby status. For example:
- When the primary instance is running normally, the global endpoint points to the primary instance.
- If the primary instance fails, click Initiate Failover to switch requests to the standby instance without changing the connection endpoint, while the primary instance triggers a decoupling action.
Prerequisites
Private endpoints have been created for all tenants in both primary and standby instances. For more information, see Get connection string.
You have Project Admin and Instance Admin permissions.
Procedure
Log in to the OceanBase Cloud Console.
In the left navigation pane, click Instances.
In the instance list, expand your target cluster instance and click the target tenant name to enter the Overview page of the tenant.
In the Topology Diagram section, click Get Connection String next to Global Endpoint.
In the popup dialog box, enter the global endpoint prefix, primary tenant private IP, and standby tenant private IP.
Global endpoint prefix: A custom prefix that consists of lowercase letters, digits, and hyphens (-). Must start with a letter and end with a letter or number. Length must be 10-40 characters. Ensure the prefix is unique.
Primary tenant private IP:
- Navigate to the Overview page of the tenant of the primary instance and copy the private endpoint in the Topology Diagram section, for example:
privatelink-xxxx-xxxx.aws-ap-southeast-1.oceanbase.cloud:xxxx. - Open your terminal and enter
ping privatelink-xxxx-xxxx.aws-ap-southeast-1.oceanbase.cloud. - Press Enter to view your primary tenant private IP.
- Navigate to the Overview page of the tenant of the primary instance and copy the private endpoint in the Topology Diagram section, for example:
Standby tenant private IP:
- Navigate to the Overview page of the tenant of the standby instance and copy the private endpoint in the Topology Diagram section, for example:
privatelink-xxxx-xxxx.aws-ap-southeast-1.oceanbase.cloud. - Open your terminal and enter
ping privatelink-xxxx-xxxx.aws-ap-southeast-1.oceanbase.cloud. - Press Enter to view your standby tenant private IP.
- Navigate to the Overview page of the tenant of the standby instance and copy the private endpoint in the Topology Diagram section, for example:
Click OK to complete the global endpoint configuration.
Log in to the OceanBase Cloud Console.
In the left navigation pane, click Instances.
In the instance list, expand your target cluster instance and click the target tenant name to enter the Overview page of the tenant.
In the Topology Diagram section, click Get Connection String next to Global Endpoint.
In the popup dialog box, enter the global endpoint prefix, primary tenant private IP, and standby tenant private IP.
Global endpoint prefix: A custom prefix that consists of lowercase letters, digits, and hyphens (-). Must start with a letter and end with a letter or number. Length must be 10-40 characters. Ensure the prefix is unique.
Primary tenant private IP: Navigate to the Private Service Connect page, and copy the IP address of the endpoint for the primary instance.
Standby tenant private IP: Navigate to the Private Service Connect page, and copy the IP address of the endpoint for the standby instance.
Click OK to complete the global endpoint configuration.
Log in to the OceanBase Cloud Console.
In the left navigation pane, click Instances.
In the instance list, expand your target cluster instance and click the target tenant name to enter the Overview page of the tenant.
In the Topology Diagram section, click Get Connection String next to Global Endpoint.
In the popup dialog box, enter the global endpoint prefix, primary tenant private IP, and standby tenant private IP.
Global Endpoint prefix: A custom prefix that consists of lowercase letters, digits, and hyphens (-). Must start with a letter and end with a letter or number. Length must be 10-40 characters. Ensure the prefix is unique.
Primary tenant private IP: Navigate to the Overview page of the tenant of the primary instance, click Get Connection String next to Private Endpoint in the Topology Diagram, and copy the private IP shown in the dialog box.
Standby tenant private IP: Navigate to the Overview page of the tenant of the standby instance, click Get Connection String next to Private Endpoint in the Topology Diagram, and copy the private IP shown in the dialog box.
Click OK to complete the global endpoint configuration.
Log in to the OceanBase Cloud Console.
In the left navigation pane, click Instances.
In the instance list, expand your target cluster instance and click the target tenant name to enter the Overview page of the tenant.
In the Topology Diagram section, click Get Connection String next to Global Endpoint.
In the popup dialog box, enter the global endpoint prefix, primary tenant private IP, and standby tenant private IP.
Global Endpoint prefix: A custom prefix that consists of lowercase letters, digits, and hyphens (-). Must start with a letter and end with a letter or number. Length must be 10-40 characters. Ensure the prefix is unique.
Primary tenant private IP:
- Navigate to the Overview page of the tenant of the primary instance and copy the private endpoint in the Topology Diagram section, for example:
xxxx.aliyun-ap-southeast-5.oceanbase.cloud:xxxx. - Open your terminal and enter
ping xxxx.aliyun-ap-southeast-5.oceanbase.cloud. - Press Enter to view your primary tenant private IP.
- Navigate to the Overview page of the tenant of the primary instance and copy the private endpoint in the Topology Diagram section, for example:
Standby tenant private IP:
- Navigate to the Overview page of the tenant of the standby instance and copy the private endpoint in the Topology Diagram section, for example:
xxxx.aliyun-ap-southeast-5.oceanbase.cloud:xxxx. - Open your terminal and enter
ping xxxx.aliyun-ap-southeast-5.oceanbase.cloud. - Press Enter to view your standby tenant private IP.
- Navigate to the Overview page of the tenant of the standby instance and copy the private endpoint in the Topology Diagram section, for example:
Click OK to complete the global endpoint configuration.