All Products
Search
Document Center

Global Accelerator:Create and manage endpoint groups of custom routing listeners

Last Updated:Apr 01, 2026

With custom routing, your application controls which backend server each client connects to. Instead of GA selecting a server, your app maps each client to a specific IP address and port within a vSwitch.

This topic describes how to create and manage endpoint groups for custom routing listeners.

Prerequisites

Before you begin, ensure that you have:

  • A standard Global Accelerator (GA) instance. For more information, see Create and manage standard GA instances .

  • A basic bandwidth plan purchased and associated with the GA instance. The bandwidth billing method of the GA instance must be subscription.

  • An application deployed as the endpoint. Only vSwitches can be used as endpoints for custom routing listeners. For more information, see the "Endpoints" section of the Overview topic.

  • Access to custom routing listeners. Custom routing listeners are in invitational preview. To request access, contact your account manager. After your request is approved, you can use custom routing listeners.

  • Security group rules or access control rules on the endpoint that allow the CIDR block of the vSwitch. The vSwitch CIDR block must have at least 8 idle private IP addresses.

How it works

After you create a custom routing listener, GA builds a mapping table from three inputs: the listener port range, the destination endpoint group port range, and the subnet information of the endpoint vSwitch. Using this mapping table, GA can forward traffic to all IP addresses, or to specific IP addresses and ports, within the vSwitch.

Custom routing listeners support TCP and UDP only. By default, each custom routing listener supports up to two endpoint groups. To increase this limit, go to the Quota Management page and raise the gaplus_quota_epgs_per_listener quota. For more information, see Manage GA quotas .

Create an endpoint group

  1. Log on to the GA console .

  2. On the Instances page, find the GA instance and click Configure Listeners in the Actions column.

  3. On the Listeners tab, click Add Listener .

    Skip this step if no listener exists yet for this instance.

  4. In the Configure Listener & Protocol step, select Custom Routing as the routing type, configure the listener port range, and click Next . For more information, see Add and manage custom routing listeners .

  5. In the Configure Endpoint Group step, configure the endpoint group and its endpoints. Endpoint groups define the mappings between listener port ranges, backend service port ranges, and protocols. Endpoints specify the backend destination CIDR blocks and subnet traffic access policies.

    1. Configure the endpoint group parameters.

      ParameterDescription
      Endpoint Group NameEnter a name for the endpoint group.
      RegionSelect the region where the endpoint group is deployed.
      Port Mapping Range and ProtocolMap backend service port ranges and protocols to the listener port range. Use List Mode to add up to 20 entries, or Batch Mode to add up to 100 entries. In List Mode, enter a port range and select TCP, UDP, or both. In Batch Mode, enter port ranges and protocols manually or upload a template.

      The following constraint applies to port capacity: Number of endpoint group ports × Number of IP addresses across all vSwitch endpoints ≤ Number of listener ports.

    2. Configure endpoints. In the Endpoint section, click Add Endpoint. In the Add Endpoint dialog box, configure the following parameters and click OK.

      ParameterDescription
      Backend Service TypeSet to vSwitch.
      Backend ServiceSelect the vSwitch to forward traffic to.
      Subnet TrafficSelect an access policy for subnet traffic. The default is Deny All Traffic, which means GA does not forward traffic to the specified backend service. Select Allow All Traffic to forward all traffic to the vSwitch. Select Allow Traffic from Specific vSwitch IP Address and Port to specify individual Elastic Compute Service (ECS) instance IP addresses and ports as destinations—use List Mode to add up to 20 entries, or Batch Mode to add up to 100 entries.
    3. (Optional) Click + Add Endpoint Group to add more endpoint groups by repeating the steps above.

      The default limit is two endpoint groups per custom routing listener. To add more, raise the gaplus_quota_epgs_per_listener quota. For more information, see Manage GA quotas.

    4. If your GA instance does not have cross-border acceleration enabled but your service requires acceleration between the Chinese mainland and regions outside the Chinese mainland—including China (Hong Kong), China (Macao), and China (Taiwan)—read Compliance Commitments Regarding Cross-border Data Transfers in the Cross-border Acceleration Settings section and select Agree to the Preceding Compliance Agreement . After you agree, the Transmission Network Type of the GA instance is automatically set to BGP (Multi-ISP) Pro . For more information, see Pay-by-data-transfer .

    5. Click Next .

  6. In the Confirm step, review the listener and endpoint configurations, then click Submit . To change any setting, click Modify in the corresponding section.

    A new listener takes effect within 3 minutes. Changes to an existing listener take effect within 1 minute.

More operations

Operation Steps
Modify an endpoint group 1. On the Listeners tab, click the listener ID. <br>2. On the listener details page, click the Endpoint Group tab. <br>3. To rename the endpoint group, hover over the name in the Endpoint Group ID/Name column and click the edit icon that appears. <br>4. To change port mapping ranges and protocols, click the number in the Port Mapping Range and Protocol column. In the Port Mapping Range and Protocol panel, click Modify to update an existing entry, Add to add an entry, or Delete (or Batch Delete ) to remove entries, then confirm by clicking OK . For limits on port mapping ranges, see the "Listener ports" section of the Overview topic.
Add an endpoint 1. On the Listeners tab, click the listener ID. <br>2. On the listener details page, click the Endpoint Group tab. <br>3. Find the endpoint group and click Add Endpoint in the Actions column. <br>4. In the Add Endpoint dialog box, select the Backend Service and the Subnet Traffic access policy, then click OK .
Modify an endpoint 1. On the Listeners tab, click the listener ID. <br>2. On the listener details page, click the Endpoint Group tab. <br>3. Click the number in the Endpoints column for the endpoint group. <br>4. On the endpoint group details page, find the endpoint. To change the subnet traffic access policy, click Modify in the Actions column and select a new policy in the Edit Endpoint dialog box. To add a traffic destination, click Add Access Policy in the Actions column. To manage existing traffic destinations, click the number in the Access Policy column, then use Modify , Add , Delete , or Batch Delete in the Access Policy panel.
Delete an endpoint 1. On the Listeners tab, click the listener ID. <br>2. On the listener details page, click the Endpoint Group tab. <br>3. Click the number in the Endpoint column for the endpoint group. <br>4. On the endpoint group details page, find the endpoint and click Delete in the Actions column. <br>5. Click OK to confirm.
Delete an endpoint group 1. On the Listeners tab, click the listener ID. <br>2. On the listener details page, click the Endpoint Group tab. <br>3. Find the endpoint group and click Delete in the Actions column. <br>4. In the Delete Endpoint Group message, click OK .

API reference

API Description
CreateCustomRoutingEndpointGroups Creates multiple endpoint groups for a custom routing listener.
UpdateCustomRoutingEndpointGroupAttribute Modifies the name and description of an endpoint group.
DeleteCustomRoutingEndpointGroups Deletes multiple endpoint groups.
CreateCustomRoutingEndpointGroupDestinations Creates port mappings for an endpoint group.
UpdateCustomRoutingEndpointGroupDestinations Modifies the port mappings of an endpoint group.
DeleteCustomRoutingEndpointGroupDestinations Deletes the port mappings of an endpoint group.
CreateCustomRoutingEndpoints Creates endpoints for a custom routing listener.
UpdateCustomRoutingEndpoints Modifies endpoints of a custom routing listener.
DeleteCustomRoutingEndpoints Deletes endpoints of a custom routing listener.
CreateCustomRoutingEndpointTrafficPolicies Creates traffic destinations for endpoints.
UpdateCustomRoutingEndpointTrafficPolicies Modifies traffic policies for endpoints.
DeleteCustomRoutingEndpointTrafficPolicies Deletes traffic policies for endpoints.
ListCustomRoutingPortMappings Lists the port mappings of a custom routing listener.
ListCustomRoutingPortMappingsByDestination Lists the port mappings of a specific backend instance.