All Products
Search
Document Center

PolarDB:Modify or delete an endpoint

Last Updated:Mar 26, 2025

When you connect to a PolarDB cluster, you must provide an endpoint of the PolarDB cluster. A PolarDB cluster provides public endpoints and private endpoints. This topic describes how to modify or delete an endpoint in the PolarDB console.

Modify the endpoint of a cluster

  1. Log on to the PolarDB console. In the left-side navigation pane, click Clusters. In the upper-left corner of the page, select the region in which the cluster resides and click the ID of the cluster to go to the Basic Information page.

  2. You can modify the endpoint of a cluster based on the cluster type.

    PolarDB for PostgreSQL centralized cluster

    PolarDB for PostgreSQL centralized clusters refer to clusters whose database engine is Enterprise Edition or Standard Edition.

    In the Database Connection section of the Basic Information page, find the endpoint and choose image > Edit to the right of Private or Public endpoint to modify the endpoint.

    image

    Important
    • The prefix of the endpoint must meet the following requirements:

      • It must be 6 to 40 characters in length and can contain lowercase letters, digits, and hyphens (-).

      • It must start with a lowercase letter and end with a digit or letter.

    • The port number must be a value within the range of 1000 to 5999.

    • If SSL is enabled for the endpoint, the cluster restarts after you modify the endpoint.

    • If SSL is enabled for the endpoint, the total length of the new endpoint cannot exceed 64 characters.

    PolarDB for PostgreSQL distributed cluster

    1. In the Database Connection section of the Basic Information page, find the endpoint and click image to the right of Private or Public endpoint to modify the endpoint.

      image

    2. In the dialog box that appears, specify a prefix for the endpoint and click OK.

      Note
      • The prefix of the endpoint must meet the following requirements:

        • It must be 6 to 40 characters in length and can contain lowercase letters, digits, and hyphens (-).

        • It must start with a lowercase letter and end with a digit or letter.

      • The port number must be a value within the range of 1000 to 5999.

Delete an endpoint

Warning
  • You can only delete public endpoints.

  • You cannot delete the public endpoint of a PolarDB for PostgreSQL cluster of the Distributed Edition.

  • Before you delete an endpoint, make sure that your application is connected to the cluster by using another endpoint.

  • The deleted endpoint cannot be restored. You can click Apply next to the required endpoint type in the console to apply for a new endpoint.

  • The default cluster endpoint can be modified but cannot be deleted. Custom cluster endpoints can be deleted.

  1. Log on to the PolarDB console. In the left-side navigation pane, click Clusters. In the upper-left corner of the page, select the region in which the cluster resides and click the ID of the cluster to go to the Basic Information page.

  2. In the Database Connection section of the Basic Information page, find the endpoint and choose image > Release to the right of Public endpoint to modify the endpoint.

    image

Related API operations

Operation

Description

DescribeDBClusterEndpoints

Queries the endpoints of a PolarDB cluster.

CreateDBEndpointAddress

Creates a public endpoint for a PolarDB cluster.

ModifyDBEndpointAddress

Modifies the default endpoint of a PolarDB cluster.

DeleteDBEndpointAddress

Deletes a cluster endpoint of a PolarDB cluster.