This topic describes how to configure the global endpoint for primary and standby instances across different cloud vendors.
Background information
A global endpoint for primary and standby databases is a single connection address that clients can use to access both databases. If the primary database fails, the system can route requests to the standby database without requiring changes to the application's connection string. This reduces the need to modify how applications manage connection addresses and helps ensure service high availability.
Global Endpoint: A virtual network address that clients use to access a database. The system automatically routes requests to the appropriate database 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. Requests are then switched to the standby instance without changing the connection endpoint, and a decoupling operation is triggered on the primary instance.
Prerequisites
Private endpoints have been created for all tenants in both primary and standby instances. For specific procedures, refer to 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:xxxx. - 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 go to the Tenant Workbench.
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 (-). It must start with a letter and end with a letter or digit, and must be 10 to 40 characters long. Ensure that the prefix is unique.
Primary tenant private IP: You can enter a private endpoint domain name or IP address. We recommend that you use the private endpoint domain name displayed by ODP. If the ODP address changes, the ODP address to which the global endpoint points is automatically updated.
- Domain name example:
xxxxx.oceanbase.cloud - IP address example:
xxx.xxx.xxx.xxx - Obtain method: Go to the tenant workbench of the primary instance. In the Topology Diagram section, click Get Connection String next to Private Endpoint, and copy the private endpoint domain name.
- Domain name example:
Standby tenant private IP: You can enter a private endpoint domain name or IP address. We recommend that you use the private endpoint domain name displayed by ODP. If the ODP address changes, the ODP address to which the global endpoint points is automatically updated.
- Domain name example:
xxxxx.oceanbase.cloud - IP address example:
xxx.xxx.xxx.xxx - Obtain method: Go to the tenant workbench of the standby instance. In the Topology Diagram section, click Get Connection String next to Private Endpoint, and copy the private endpoint domain name.
- Domain name 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 go to the Tenant Workbench.
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 (-). It must start with a letter and end with a letter or digit, and must be 10 to 40 characters long. Ensure that the prefix is unique.
Primary tenant private IP: You can enter a private endpoint domain name or IP address. We recommend that you use the domain name displayed by ODP. If the ODP address changes, the ODP address to which the global endpoint points is automatically updated.
- Domain name example:
xxxx.aliyun-ap-southeast-5.oceanbase.cloud - IP address example:
xxx.xxx.xxx.xxx
- Domain name example:
Standby tenant private IP: You can enter a private endpoint domain name or IP address. We recommend that you use the domain name displayed by ODP. If the ODP address changes, the ODP address to which the global endpoint points is automatically updated.
- Domain name example:
xxxx.aliyun-ap-southeast-5.oceanbase.cloud - IP address example:
xxx.xxx.xxx.xxx
- Domain name example:
Click OK to complete the global endpoint configuration.