All Products
Search
Document Center

VPN Gateway:DeleteVpnAttachment

Last Updated:Dec 20, 2024

Deletes an IPsec-VPN connection.

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
vpc:DeleteVpnAttachmentdelete
*VpnConnections
acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the IPsec-VPN connection.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
VpnConnectionIdstringYes

The ID of the IPsec-VPN connection.

vco-p0w7gtr14m09r9lkr****
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 client token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
123e4567-e89b-12d3-a456-4266****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

29440C49-398F-3D06-BA8B-E3CD13F3246D
Codestring

The status code returned by the current operation. 200 indicates that the operation is successful.

200
Successboolean

Indicates whether the current operation is successful.

  • true
  • false
true
Messagestring

The information returned by the current operation.

successful

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400VpnConnection.ConfiguringThe specified service is configuring.The service is being configured. Try again later.
400InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error occurred.
400Vco.StatusNotSupportThe 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.
403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user. -
403Forbidden User not authorized to operate on the specified resource. -
404InvalidVpnConnectionInstanceId.NotFound The specified vpn connection instance id does not exist. -

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

Change history

Change timeSummary of changesOperation
2024-10-24The Error code has changedView Change Details
2024-01-04API Description Update. The Error code has changedView Change Details