All Products
Search
Document Center

PolarDB:DeleteDBEndpointAddress

Last Updated:Oct 10, 2024

Releases the public endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, and custom cluster endpoint.

Operation description

Note
  • You can delete a public-facing or classic network endpoint of the primary endpoint, the default cluster endpoint, or a custom cluster endpoint.
  • Classic network endpoints are supported only on the China site (aliyun.com). Therefore, you do not need to delete classic network endpoints on the International site (alibabacloud.com).
  • Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    polardb:DeleteDBEndpointAddressdelete
    • Endpoint
      acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}
      none
    none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The ID of the cluster.

    Note You can call the DescribeDBClusters operation to query the details of all clusters that belong to your account, such as the cluster ID.
    pc-************
    DBEndpointIdstringYes

    The ID of the endpoint.

    Note You can call the DescribeDBClusterEndpoints operation to query the endpoints of a specified PolarDB cluster.
    pe-***************
    NetTypestringYes

    The network type of the endpoint. Set the value to Public (public network).

    Public

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBEndpointId.MalformedThe specified parameter DBEndpointId is not valid.The specified DBEndpointId parameter is invalid.
    400NetTypeUsed.GdnSpecified endpoint‘s net type is used by global database.The GDN uses the network type of the specified endpoint.
    400InvalidNetType.MalformedThe specified parameter NetType is not valid.The specified NetType parameter is invalid.
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404EndpointStatus.NotSupportCurrent endpoint status does not support this operation.This operation is not supported while the node is in the current state.
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-09-12The Error code has changedView Change Details
    2023-08-15The Error code has changedView Change Details
    2023-05-11The Error code has changedView Change Details