Call DeleteVpnAttachment to delete an IPsec-VPN connection - VPN Gateway - Alibaba Cloud - VPN Gateway

Operation description

If the IPsec-VPN connection is associated with a transit router instance, disassociate the IPsec-VPN connection from the transit router instance before you delete the IPsec-VPN connection. For more information, see DeleteTransitRouterVpnAttachment.
If the IPsec-VPN connection is not associated with any resource, you can call the DeleteVpnAttachment operation to directly delete the IPsec-VPN connection.

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:DeleteVpnAttachment

delete

*VpnConnections

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPsec-VPN connection. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
VpnConnectionId	string	Yes	The ID of the IPsec-VPN connection.	vco-p0w7gtr14m09r9lkr****
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. The ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId value as the ClientToken value. The RequestId value is different for each API request.	123e4567-e89b-12d3-a456-4266****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	29440C49-398F-3D06-BA8B-E3CD13F3246D
Code	string	The status code returned by the current task. A value of 200 indicates that the task is successful.	200
Success	boolean	Indicates whether the current task is successfully executed. true: The task is successfully executed. false: The task failed to be executed.	true
Message	string	The message returned by the current task.	successful

Examples

Success response

JSON format

{
  "RequestId": "29440C49-398F-3D06-BA8B-E3CD13F3246D",
  "Code": "200",
  "Success": true,
  "Message": "successful"
}

Error codes

HTTP status code	Error code	Error message	Description
400	VpnConnection.Configuring	The specified service is configuring.	The service is being configured. Try again later.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
400	Vco.StatusNotSupport	The current VCO status does not support operations such as modification and deletion.	The current VCO status does not support operations such as modification and deletion.
400	CrossAccountAuthorizedVco.NotAllowDelete	Current vpn connection is cross account authorized to cen, should delete cross account authorization first.	the current vpn connection instance is cross-account authorized to the cen of another account. you need to cancel the cross-account authorization before deleting the instance.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.