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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| polardb:DeleteDBEndpointAddress | delete |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBClusterId | string | Yes | 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-************ |
| DBEndpointId | string | Yes | The ID of the endpoint. Note
You can call the DescribeDBClusterEndpoints operation to query the endpoints of a specified PolarDB cluster.
| pe-*************** |
| NetType | string | Yes | The network type of the endpoint. Set the value to Public (public network). | Public |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-09-12 | The Error code has changed | View Change Details |
| 2023-08-15 | The Error code has changed | View Change Details |
| 2023-05-11 | The Error code has changed | View Change Details |