All Products
Search
Document Center

PolarDB:Manage the endpoints of a cluster

Last Updated:Dec 18, 2023

You can use a cluster endpoint or the primary endpoint of a PolarDB cluster to connect to the cluster. This topic describes how to apply for and manage cluster endpoints or primary endpoints.

Apply for a public cluster endpoint or a primary endpoint

  1. Log on to the PolarDB console.
  2. In the upper-left corner of the console, select the region in which the cluster that you want to manage is deployed.
  3. Find the cluster and click the cluster ID.
  4. In the Dedicated Enterprise Edition or Standard Enterprise Edition section of the Basic Information page, you can apply for an endpoint by using one of the following methods:

    • Method 1:

      1. In the upper-right corner of the Dedicated Enterprise Edition or Standard Enterprise Edition section, click the 切换 icon to switch the view.

      2. Click Apply next to the Public field.申请地址

    • Method 2

      1. On the right side of the cluster endpoint, click Modify.

      2. In the Network Information section of the dialog box that appears, click Apply.4

    Note

    You can apply only for Public endpoints. After you create a cluster, a default Private endpoint is generated. You do not need to apply for this endpoint.

  5. 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.

    After an application for the cluster endpoint is approved, all features that can be provided by PolarProxy are supported. You can modify the parameter settings of the features provided by PolarProxy based on your business requirements. For more information, see Configure PolarProxy.

Create a custom cluster endpoint

In the Dedicated Enterprise Edition or Standard Enterprise Edition section of the Basic Information page, click Create Custom Cluster Endpoint. In the dialog box that appears, create a custom cluster endpoint and configure the features provided by PolarProxy for the custom cluster endpoint. For more information, see Configure PolarProxy.

Note

PolarDB for MySQL Cluster Edition allows you to specify a VPC and a vSwitch when you create an endpoint. For more information, see Change the VPC and vSwitch for a PolarDB for MySQL cluster.

View the endpoint and port number

You can view the domain name and port number of an endpoint by using one of the following methods:

  • In the upper-right corner of the Dedicated Enterprise Edition or Standard Enterprise Edition section, click the 切换 icon to switch the view. Then, you can view the domain name and port number of the endpoint.

  • On the right side of the cluster endpoint, click Modify. In the Network Information section of the dialog box that appears, you can view the domain name and port number of the endpoint.2

Note
  • If you use a domain name to connect to a database, you can click Bind Private Domain Name to bind the domain name to a private endpoint. This allows you to retain the original database domain name after the database is migrated to the cloud. Only Private endpoints can be bound to private domain names. For more information, see Private domain names.

  • The default port number of an endpoint that is used by a PolarDB cluster is 3306. You can change the port number. For more information, see Change the endpoint of a cluster.

Changes the endpoint of a cluster

You can change the domain name and port number of an endpoint by using one of the following methods:

  • In the upper-right corner of the Dedicated Enterprise Edition or Standard Enterprise Edition section, click the 切换 icon to switch the view. Then, find the endpoint that you want to manage and click Modify.

  • On the right side of the cluster endpoint, click Modify. In the Network Information section of the dialog box that appears, choose More > Modify.2

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 ranges from 3000 to 3500.

  • 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.

Note

PolarDB for MySQL Cluster Edition allows you to change the VPC and vSwitch of a single endpoint. For more information, see Change the VPC and vSwitch for a PolarDB for MySQL cluster.

Delete an endpoint

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

  • A deleted endpoint cannot be recovered. If you need an endpoint, click Apply to apply for a new endpoint. For more information, see Apply for a public cluster endpoint or primary endpoint.

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

You can delete an endpoint by using one of the following methods:

  • In the upper-right corner of the Dedicated Enterprise Edition or Standard Enterprise Edition section, click the 切换 icon to switch the view. Then, find the endpoint that you want to manage and click Release.

  • On the right side of the cluster endpoint, click Modify. In the Network Information section of the dialog box that appears, choose More > Release.1

Note

Only Public endpoints can be deleted.

What to do next

Connect to a cluster

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 an endpoint of a PolarDB cluster.