All Products
Search

This Product

    VPN Gateway:DeleteVpnConnection

    Document Center

    VPN Gateway:DeleteVpnConnection

    Last Updated:Nov 13, 2024

    Deletes an IPsec-VPN connection.

    Operation description

    • DeleteVpnConnection is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeVpnGateway operation to query the status of a VPN gateway.

      • If a VPN gateway is in the updating state, the IPsec-VPN connection is being deleted.
      • If a VPN gateway is in the active state, the IPsec-VPN connection has been deleted.

    • You cannot call the DeleteVpnConnection operation to delete multiple IPsec-VPN connections for a VPN gateway at a time.

    Note After an IPsec-VPN connection between a data center and Alibaba Cloud is deleted, the connection between the data center and Alibaba Cloud is closed.

    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:DeleteVpnConnectiondelete
    • VpnConnection
      acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The ID of the region where the IPsec-VPN connection is created.

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

    		cn-hangzhou
    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.
    		02fb3da4-130e-11e9-8e44-0016e04115b
    VpnConnectionIdstringYes

    The ID of the IPsec-VPN connection.

    		vco-bp1bbi27hojx80nck****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		606998F0-B94D-48FE-8316-ACA81BB230DA

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "606998F0-B94D-48FE-8316-ACA81BB230DA"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400VpnGateway.ConfiguringThe specified service is configuring.The service is being configured. Try again later.
    400VpnTask.CONFLICTVpn task has conflict.The VPN operation conflicts. Try again later.
    400VpnGateway.FinancialLockedThe specified service is financial locked.The service is suspended due to overdue payments. Top up your account first.
    400InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error occurred.
    400InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.The specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.
    403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
    403ForbiddenUser 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.
    404InvalidVpnConnectionInstanceId.NotFoundThe specified vpn connection instance id does not exist.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-01-04API Description Update. The Error code has changedView Change Details