You can call this operation to modify the endpoints of a specified Apsara PolarDB cluster, including the primary endpoint, default cluster endpoint, custom cluster endpoint, and private domain.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required Example Description
Action String No ModifyDBEndpointAddress

The operation that you want to perform. Set the value to ModifyDBEndpointAddress.

DBClusterId String Yes pc-xxxxxxxxxx

The ID of the Apsara PolarDB cluster that you want to manage.

DBEndpointId String Yes pe-xxxxxxxxxx

The ID of the endpoint for the Apsara PolarDB cluster. Example: pe-xxxxxxxx.

Note You can call the DescribeDBClusterEndpoints operation to query endpoint IDs.
NetType String Yes Public

The network type of the endpoint. Valid values:

  • Public: public-facing endpoint
  • Private: VPC-facing endpoint
  • Inner: internal-facing endpoint (classic network)
ConnectionStringPrefix String No pc-xxxxxxxxxx-pub2

The prefix of the new endpoint. The prefix must comply with the following rules:

  • It cannot end with a hyphen (-).
  • It must start with a letter. It can contain lowercase letters, digits, and hyphens (-).
  • It must be more than six characters in length.
PrivateZoneAddressPrefix String No xxxxxxxxxxx

The prefix of a private domain name.

You can bind a private domain name to each VPC-facing endpoint of an Apsara PolarDB cluster. Private domain names only apply to the VPC that you specify within the current region. Private domains are managed through PrivateZone. You can use the CNAME record of the PrivateZone to map domain names to Apsara PolarDB. The PrivateZone feature will charge you a small amount of fees. For more information, see Pricing.

Note The parameter takes effect only when NetType=Private.
PrivateZoneName String No

The description of the PrivateZone.

Note The parameter takes effect only when NetType=Private.

Response parameters

Parameter Type Example Description
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

The ID of the request.


Sample requests

http(s)://[Endpoint]/? Action=ModifyDBEndpointAddress
&<Common request parameters>

Sample success responses

XML format


JSON format

  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"

Error codes

For a list of error codes, visit the API Error Center.