DeleteVpnConnection--VPN连接-火山引擎

文档中心

立即注册

导航

DeleteVpnConnection

最近更新时间：2024.08.09 15:51:21首次发布时间：2022.04.28 07:17:15

调用DeleteVpnConnection删除指定的IPsec连接。

调用说明

删除IPsec连接会同时删除VPN网关中下一跳为该IPsec连接的所有路由条目。
已绑定中转路由器的IPsec连接不可直接删除，如需删除请先调用DeleteTransitRouterVpnAttachment从中转路由器侧删除IPsec连接实例。

注意

删除IPsec连接后被删除的连接立即失效，可能会对您正在运行的业务产生影响，请谨慎操作。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DeleteVpnConnection	要执行的操作，取值：DeleteVpnConnection。
Version	String	是	2020-04-01	API版本信息。
VpnConnectionId	String	是	vgc-3tex2x1cwd4c6c0v****	待删除IPsec连接的ID。您可调用DescribeVpnConnections查询IPsec连接的ID信息。

返回数据

名称	类型	示例值	描述
RequestId	String	202203211611080102121461940900****	请求ID。
OrderId	String	Order7078570823273845036	删除绑定TR实例的IPsec连接的订单ID。删除绑定VPN网关的IPsec连接不返回此参数。

请求示例

GET /?Action=DeleteVpnConnection&Version=2020-04-01&VpnConnectionId=vgc-2bzvqi8kerd342dx0eg2f**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202203211611080102121461940900****",
        "Action": "DeleteVpnConnection",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202203211611080102121461940900****",
        "OrderId": "Order7078570823273845036"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidVpnGateway.InvalidStatus	The specified VPN gateway is not in the correct status for the request.	指定的VPN网关所处的状态无法响应该请求。
400	InvalidCustomerGateway.InvalidStatus	The specified customer gateway is not in the correct status for the request.	指定的用户网关所处的状态无法响应该请求。
400	IncorrectVpnConnectionAttachStatus	The operation is not supported by the current IPSec connection attach status.	当前操作不支持，请稍后重试。
400	IncorrectVpnConnectionStatus	The operation is not supported by the current vpn connection.	当前操作不支持，请稍后重试。
400	InvalidVpnConnection.InvalidAttachStatus	The specified IPSec has been attached to a Transit Router.	当前操作不支持，IPSec连接已绑定至中转路由器，请先解绑。
400	OrderError	Failed to create an order in one step.	创建订单并支付失败。
404	InvalidVpnConnection.NotFound	The specified IPSec connection does not exist.	指定的IPSec连接不存在。