DeleteVpcEndpoint - PrivateLink - Alibaba Cloud Documentation Center

Deletes an endpoint.

Operation description

Before you delete an endpoint, make sure that all zones associated with the endpoint have been deleted.
DeleteVpcEndpoint is an asynchronous operation. After you send a request, the system returns a request ID and deletes the endpoint in the background. You can call the GetVpcEndpointAttribute operation to query the status of the endpoint.
- If the endpoint status is Deleting, the endpoint is being deleted.
- If the endpoint cannot be queried, the endpoint has been deleted.

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 support 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

privatelink:DeleteVpcEndpoint

delete

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint that you want to delete. Call the DescribeRegions operation to obtain the region ID.	eu-west-1
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. ClientToken can contain only ASCII characters.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request format, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
EndpointId	string	Yes	The ID of the endpoint that you want to delete.	ep-hp33b2e43fays7s8****
RegionId	string	Yes	The region ID of the endpoint that you want to delete. Call the DescribeRegions operation to obtain the region ID.	eu-west-1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	8D8992C1-6712-423C-BAC5-E5E817484C6B

Examples

Success response

JSON format

{
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.EndpointProtected	The operation is not allowed because of EndpointProtected.	Managed protection is enabled for the endpoint. Operation is not allowed.
400	EndpointOperationDenied	The specified operation of endpoint is not allowed.	The specified operation of endpoint is not allowed.
400	EndpointDependenceViolation	The specified endpoint has dependent zone(s).	The specified endpoint has dependent zone(s).
400	EndpointNotFound	The specified Endpoint does not exist.	The specified Endpoint does not exist.
400	EndpointProtected	The specified Endpoint is protected.
400	EndpointAssociatedVpc	The endpoint is associated with a vpc.	the endpoint has been associated with a vpc. delete the route entry of the endpoint first.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.