All Products
Search
Document Center

PolarDB:Custom endpoints (legacy)

Last Updated:Aug 24, 2026

PolarDB-XEnterprise Edition provides custom endpoints to help you distribute business traffic to specific sets of compute nodes.

Limitations

You can create custom endpoints only forPolarDB-XCreate a custom endpoint in an Enterprise Edition instance.

Usage notes

Each custom endpoint must include at least two compute nodes.

Benefits

Typically, aPolarDB-XAn Enterprise Edition instance has two or more compute nodes, and the number of compute nodes mounted to the internal endpoint cannot be modified. In this case, you cannot customize the allocation of compute nodes for different business traffic. To meet more customization requirements,PolarDB-XEnterprise Edition provides custom endpoints with the following benefits:

  • Physical isolation of business traffic: Different businesses can use different custom endpoints, and the compute nodes mounted to these custom endpoints do not overlap, achieving physical isolation of business traffic.

  • Reducing network latency for cross-data center access:PolarDB-XAn Enterprise Edition multi-zone instance has a group of compute nodes in each of the primary and secondary zones. You can create different custom endpoints in the primary and secondary zones and provide them to the application APPs deployed in the primary and secondary zones respectively, to access compute nodes nearby and reduce network latency for cross-data center access.

CreateCustom endpoint

  1. Log on to the PolarDB Distributed Edition console.

  2. In the top navigation bar, select the region where the instance is deployed.

  3. On the Instances page, click the PolarDB-X 2.0 tab.

  4. Find the instance and click Instance ID to go to the instance details page.

  5. In the left-side navigation pane, clickConnection Management

  6. In the upper-left corner, clickCreate Custom Connection. In theCreate Custom Connectionpanel and configure the following parameters.

    Parameter

    Description

    Endpoint Name

    Enter a name for the custom endpoint.

    VPC

    Select the VPC and vSwitch for the endpoint.

    Switch

    Service Node

    Select the compute nodes to associate with this custom endpoint.

    Note
    • You can associate a compute node with multiple custom endpoints.

    • Each custom endpoint must have at least two compute nodes. If an endpoint has only two nodes, you cannot disassociate either of them.

    Automatically Associate New Nodes

    Specify whether to automatically associate new compute nodes with this endpoint. The available options are:

    • Enable: New compute nodes added to the instance that matchConditions for Associating New Node, the compute node is automatically added to the current custom endpoint.

    • Close: New compute nodes added to the instance are not automatically added to this custom endpoint.

    Conditions for Associating New Node

    Specify the availability zone condition that a new compute node must meet to be automatically associated. The available options are:

    • All Availability Zones: All new compute nodes added to the instance are automatically added to the custom endpoint.

    • Same Availability Zone: When a new compute node is added to the instance and its zone matches the zone of the most recently added compute node under the custom endpoint, the new compute node is automatically added to the custom endpoint.

    Note
    • If a new compute node meets theConditions for Associating New Node, new compute nodes are automatically added to multiple custom endpoints.

    • After creating the endpoint, you canModifyCustom endpointConfirm the zone of the most recently added compute node.

  7. ClickOKto create the custom endpoint.

ModifyCustom endpoint

  1. Log on to the PolarDB Distributed Edition console.

  2. In the top navigation bar, select the region where the instance is deployed.

  3. On the Instances page, click the PolarDB-X 2.0 tab.

  4. Find the instance and click Instance ID to go to the instance details page.

  5. In the left-side navigation pane, clickConnection Management

  6. ClickCustom Endpointtab, find the target custom endpoint in the custom endpoint list, and clickModify. The following parameters can be modified:

    Parameter

    Description

    Endpoint Name

    Modify the name of the custom endpoint.

    Service Node

    Add or remove associated compute nodes.

    Note
    • You can associate a compute node with multiple custom endpoints.

    • Each custom endpoint must have at least two compute nodes. If an endpoint has only two nodes, you cannot disassociate either of them.

    • You can manually add a compute node from any availability zone, even if theConditions for Associating New NodeisSame Availability Zone, you can still manually add compute nodes in different zones.

    Network Information

    In theNetwork Informationarea and click Edit to open theModify Private Endpointdialog box. The following parameters can be configured:

    • VPC

    • vSwitch

    • The endpoint prefix, which must be 6 to 30 characters long and contain only lowercase letters, digits, and hyphens (-). It must start with a letter and end with a letter or a digit.

    • The port number, which must be a number from 3000 to 6000.

    Automatically Associate New Nodes

    Specify whether to automatically associate new compute nodes with this endpoint. The available options are:

    • Enable: New compute nodes added to the instance that matchConditions for Associating New Node, the compute node is automatically added to the current custom endpoint.

    • Close: New compute nodes added to the instance are not automatically added to this custom endpoint.

    Conditions for Associating New Node

    Specify the availability zone condition that a new compute node must meet to be automatically associated. The available options are:

    • All Availability Zones: All new compute nodes added to the instance are automatically added to the custom endpoint.

    • Same Availability Zone: When a new compute node is added to the instance and its zone matches the zone of the most recently added compute node under the custom endpoint, the compute node is automatically added to the custom endpoint.

    Note
    • If a new compute node meets theConditions for Associating New Node, new compute nodes are automatically added to multiple custom endpoints.

    • If the endpoint contains nodes from different availability zones, a dialog box appears, showing the availability zone of the last associated node.

  7. ClickOKto modify the custom endpoint.

Delete a custom endpoint

  1. Log on to the PolarDB Distributed Edition console.

  2. In the top navigation bar, select the region where the instance is deployed.

  3. On the Instances page, click the PolarDB-X 2.0 tab.

  4. Find the instance and click Instance ID to go to the instance details page.

  5. In the left-side navigation pane, clickConnection Management

  6. In the custom endpoint list, find the target custom endpoint and clickDelete

  7. In the confirmation dialog box that appears, clickDelete connectionto complete the deletion.