Call the DeleteVpnGateway API to delete a VPN gateway - VPN Gateway - Alibaba Cloud - VPN Gateway

Deletes a specified VPN gateway.

Operation description

Note

You cannot delete a VPN gateway that has IPsec-VPN connections.

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

vpc:DeleteVpnGateway

delete

*VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the VPN gateway. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The client generates the value. The value must be unique among different requests and cannot exceed 64 ASCII characters in length. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.	02fb3da4-130e-11e9-8e44-0016e04115b
VpnGatewayId	string	Yes	The ID of the VPN gateway.	vpn-bp1q8bgx4xnkm2ogj****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	>0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Success response

JSON format

{
  "RequestId": ">0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DependencyViolation.VpnConnection	There are vpn connections on specified customer gateway not deleted.	The error message returned because VPN connections to the specified customer gateway are not deleted.
400	DependencyViolation.SslVpnServer	There is SSL VPN server on specified vpn gateway not deleted.	The error message returned because SSL-VPN connections to the specified customer gateway are not deleted.
400	VpnGateway.Configuring	The specified service is configuring.
400	DependencyViolation.GreTunnel	There is Gre tunnel on specified vpn gateway not deleted.	The error message returned because GRE tunnels are not deleted on the VPN gateway.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
400	TaskConflict	The eip operate too frequent, TaskConflict.	Operations are too frequent and tasks conflict with each other.
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	The specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.
400	DependencyViolation.IpsecServer	the resource cannot be deleted because the resource has an ipsec server dependency.	the resource cannot be deleted because the resource has an ipsec server dependency.
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	The error message returned because you are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
403	ForbiddenRelease	Forbidden to release a prepaid instance within validity period
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.