You need to enable JavaScript to run this app.
导航
DeleteVpnConnection
最近更新时间:2024.08.09 15:51:21首次发布时间:2022.04.28 07:17:15

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

调用说明

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

注意

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

调试

请求参数

名称类型是否必选
示例值
描述
ActionStringDeleteVpnConnection要执行的操作,取值:DeleteVpnConnection。
VersionString2020-04-01API版本信息。
VpnConnectionIdStringvgc-3tex2x1cwd4c6c0v****待删除IPsec连接的ID。您可调用DescribeVpnConnections查询IPsec连接的ID信息。

返回数据

名称类型
示例值
描述
RequestIdString202203211611080102121461940900****请求ID。
OrderIdStringOrder7078570823273845036删除绑定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错误码错误信息描述
400InvalidVpnGateway.InvalidStatusThe specified VPN gateway is not in the correct status for the request.指定的VPN网关所处的状态无法响应该请求。
400InvalidCustomerGateway.InvalidStatusThe specified customer gateway is not in the correct status for the request.指定的用户网关所处的状态无法响应该请求。
400IncorrectVpnConnectionAttachStatusThe operation is not supported by the current IPSec connection attach status.当前操作不支持,请稍后重试。
400IncorrectVpnConnectionStatusThe operation is not supported by the current vpn connection.当前操作不支持,请稍后重试。
400InvalidVpnConnection.InvalidAttachStatusThe specified IPSec has been attached to a Transit Router.当前操作不支持,IPSec连接已绑定至中转路由器,请先解绑。
400OrderErrorFailed to create an order in one step.创建订单并支付失败。
404InvalidVpnConnection.NotFoundThe specified IPSec connection does not exist.指定的IPSec连接不存在。