All Products
Search
Document Center

PrivateLink:DeleteVpcEndpoint

Last Updated:Sep 26, 2024

Deletes an endpoint.

Operation description

  • Before you delete an endpoint, you must delete the zones that are added to the endpoint.

  • DeleteVpcEndpoint is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the GetVpcEndpointAttribute operation to check whether the endpoint is deleted.

    • If the endpoint is in the Deleting state, the endpoint is being deleted.
    • If the endpoint cannot be queried, the endpoint is deleted.

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
privatelink:DeleteVpcEndpointdelete
  • VpcEndpoint
    acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the endpoint that you want to delete. You can call the DescribeRegions operation to query the most recent region list.

eu-west-1
ClientTokenstringNo

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. The token can contain only ASCII characters.

0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, 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 performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
false
EndpointIdstringYes

The ID of the endpoint that you want to delete.

ep-hp33b2e43fays7s8****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

8D8992C1-6712-423C-BAC5-E5E817484C6B

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400OperationDenied.EndpointProtectedThe operation is not allowed because of EndpointProtected.Managed protection is enabled for the endpoint. Operation is not allowed.
400EndpointOperationDeniedThe specified operation of endpoint is not allowed.The specified operation of endpoint is not allowed.
400EndpointDependenceViolationThe specified endpoint has dependent zone(s).The specified endpoint has dependent zone(s).
400EndpointNotFoundThe specified Endpoint does not exist.The specified Endpoint does not exist.
400EndpointProtectedThe specified Endpoint is protected.-

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

Change history

Change timeSummary of changesOperation
No change history