All Products
Search

This Product

    PolarDB:DeleteDBEndpointAddress

    Document Center

    PolarDB:DeleteDBEndpointAddress

    Last Updated:Dec 11, 2025

    Deletes the public endpoint of a primary endpoint, a default cluster endpoint, or a custom cluster endpoint in a PolarDB cluster.

    Operation description

    Note

    • You can delete the public or classic network endpoint of a primary endpoint, a default cluster endpoint, or a custom cluster endpoint in a PolarDB cluster.

    • Classic network endpoints are supported only on the Alibaba Cloud China Website (www.aliyun.com). They are not supported on the Alibaba Cloud International Website (www.alibabacloud.com). Therefore, you do not need to delete classic network endpoints on the Alibaba Cloud International Website.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:DeleteDBEndpointAddress

    delete

    *Endpoint

    acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    Note

    Call the DescribeDBClusters operation to query the details of all clusters in your account, including cluster IDs.

    pc-************
    DBEndpointId

    string

    Yes

    The endpoint ID.

    Note

    Call the DescribeDBClusterEndpoints operation to query the endpoint ID.

    pe-***************
    NetType

    string

    Yes

    The network type of the endpoint. Valid values:

    Public

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    D0CEC6AC-7760-409A-A0D5-E6CD86******

    Examples

    Success response

    JSON format

    {
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

    Error response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidDBEndpointId.Malformed The specified parameter DBEndpointId is not valid. The specified DBEndpointId parameter is invalid.
    400 NetTypeUsed.Gdn Specified endpoint‘s net type is used by global database. The GDN uses the network type of the specified endpoint.
    400 InvalidNetType.Malformed The specified parameter NetType is not valid. The specified NetType parameter is invalid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.
    404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.
    404 EndpointStatus.NotSupport Current endpoint status does not support this operation. This operation is not supported while the node is in the current state.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The specified DBClusterId parameter is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.