Create a system cluster
A system cluster is a group of backend services that receive requests forwarded by API Gateway. This topic describes how to create a system cluster in the API Gateway console.
API Gateway supports system clusters that use the HTTP, SOFARPC, DUBBO, TRIPLE, and SOFA_TR protocols.
In a public cloud environment, contact the Ant Group technical support team to obtain permissions for creating TRIPLE and SOFA_TR system clusters.
HTTP protocol type
On the Scalable Open Financial Architecture page, in the navigation pane on the left, select API Unified Gateway > API Publishing > System Cluster.
On the System Cluster page, click Create System Cluster in the upper-right corner.
In the pop-up window, configure the following parameters:
System Cluster Name: Required. Enter a name for the system cluster. The name can be up to 32 characters long and can contain letters, Chinese characters, digits, underscores (_), and hyphens (-).
Protocol Type: Select HTTP (Hypertext Transfer Protocol).
Select an address configuration method.
Manual configuration: Manually specify the IP address or domain name of the system cluster.
IP address/domain name: Enter the IP address or domain name. The format is
Address:Port.IP address or domain name:
The IP address format is
(1-255).(0-255).(0-255).(0-255).A domain name can contain letters, digits, and hyphens (-). The length cannot exceed 200 characters.
The domain name must start with
http://orhttps://.
Port: The port number can range from 1 to 65535. The default port for HTTP is 80.
Choose an address configuration method.
Manual Configuration: Manually configure the IP address or domain name of the system cluster.
NoteThe middleware runs in a separate virtual private cloud (VPC). If your system cluster uses a backend service that is in a VPC and does not have a public IP address, select the Cross-VPC Cluster option.
IP Address/Domain Name: Specify the IP address or domain name in the
Address:Portformat.IP address or domain name:
The format for the IP address is
(1-200).(0-200).(0-200).(0-200).The domain name can contain letters, digits, and hyphens (-). The domain name can be up to 200 characters long.
It must start with
http://orhttps://.
The port number. The default is 80 for HTTP and 12200 for SOFARPC. The valid range is 1 to 65535.
Cross-VPC Cluster: Configure a system cluster that can be accessed across VPCs.
Before you create a cross-VPC cluster, you must prepare the VPC environment. This includes purchasing SLB and ECS instances for the VPC and setting up your backend service. For more information, see Create and manage a VPC.
Configure the following parameters:
VPC ID: Required. Enter the ID of the VPC that you want to access.
SLB Instance ID: Required. Enter the instance ID of the SLB instance or the private IP address of the ECS instance.
Enable HTTPS for backend service: This option is disabled by default, which means the backend service uses the HTTP protocol. If you enable this option, the backend service uses the HTTPS protocol.
Port number: Required. The port number of the host in the VPC channel. The value must be a 2- to 6-digit number.
Configure the following parameters:
Authentication Method: Select an authentication method. This method determines whether the gateway signs requests that are sent to the backend system cluster. You can select None or Key.
Description: Optional. Enter a description for the system cluster. The description can be up to 64 characters long.
Click OK to create the system cluster.
SOFARPC protocol type
In the console, choose API Publish > System Cluster from the navigation pane on the left.
On the System Cluster page, click Create System Cluster in the upper-right corner.
In the pop-up window, configure the following information:
System Cluster Name: Required. Enter a name for the system cluster. The name can be up to 32 characters long and can contain letters, Chinese characters, digits, underscores (_), and hyphens (-).
Protocol Type: SOFARPC, an in-house RPC call framework from Ant Group.
Address Configuration Method: Select Manual Configuration. This method lets you manually configure the IP address or domain name of the system cluster.
IP Address/Domain Name: Specify the IP address or domain name in the
Address:Portformat.IP address or domain name:
The IP address format is
(1-200).(0-200).(0-200).(0-200).The domain name can contain letters, digits, and hyphens (-). The domain name can be up to 200 characters long.
Port: The default port for SOFARPC is 12200. The port number can range from 1 to 65535.
Description: Optional. Enter a description for the system cluster. The description can be up to 64 characters long.
Click OK to create the system cluster.
DUBBO protocol type
On the Scalable Open Financial Architecture page, in the left navigation pane, select Unified API Gateway > API Publish > System Cluster.
On the System Cluster page, click Create System Cluster in the upper-right corner.
In the pop-up window, configure the following parameters:
System Cluster Name: Required. Enter a name for the system cluster. The name can be up to 32 characters long and can contain letters, Chinese characters, digits, underscores (_), and hyphens (-).
Protocol Type: Select DUBBO.
Address Configuration Method: Select Manual Configuration. This method lets you manually configure the IP address or domain name of the system cluster.
IP Address/Domain Name: Specify the IP address or domain name in the
Address:Portformat.IP address or domain name:
The IP address must be in the format
(1-200).(0-200).(0-200).(0-200).The domain name can contain letters, digits, and hyphens (-). The domain name can be up to 200 characters long.
Port: The default port for DUBBO is 80. The port number can range from 1 to 65535.
Description: Optional. Enter a description for the system cluster. The description can be up to 64 characters long.
Click OK to create the system cluster.