删除VPN通道

最近更新时间:2019-11-28 09:17:01

1. 接口描述

本接口(DeleteVpnConn)用于删除 VPN 通道。
接口请求域名:vpc.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 DeleteVpnConn。

参数名称 必选 类型 描述
vpcId string 私有网络 ID,可使用 vpcId 或 unVpcId,建议使用 unVpcId,例如:vpc-03vihbk9,可通过 DescribeVpcEx 接口查询。
vpnGwId String 系统分配的 VPN 网关 ID,可使用 vpnGwId 或 unVpnGwId,建议 unVpnGwId,例如:vpngw-dystbrkv。可通过DescribeVpnGw接口查询。
vpnConnId String 系统分配的 VPN 通道 ID,可使用 vpnConnId 或 unVpnConnId,建议使用 unVpnConnId,例如:vpnx-ol6bcqp0。可通过 DescribeVpnConn 接口查询。

3. 输出参数

参数名称 类型 描述
code Int 错误码,0:成功,其他值:失败
message String 错误信息
data.taskId Int 任务 ID,操作结果可以用taskId查询,详见 查询任务执行结果接口

4. 错误码表

以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 VPC 错误码

错误码 描述
InvalidVpc.NotFound 无效的 VPC。VPC 资源不存在,请再次核实您输入的资源信息是否正确,可通过 DescribeVpcEx 接口查询 VPC。
InvalidVpnGw.NotFound 无效的 VPN 网关。VPN 网关资源不存在,请再次核实您输入的资源信息是否正确,可通过 DescribeVpnGw 接口查询 VPN 网关。
InvalidVpnConnState VPN 通道状态不对
InvalidVpnConn.NotFound 无效的 VPN 通道。VPN 通道资源不存在,请再次核实您输入的资源信息是否正确,可通过 DescribeVpnConn 接口查询 VPN 通道。

5. 示例

输入

  https://vpc.api.qcloud.com/v2/index.php?Action=DeleteVpnConn
  &<公共请求参数>
  &vpcId=vpc-03vihbk9
  &vpnGwId=vpngw-kfldykuz
  &vpnConnId=vpnx-ol6bcqp0

输出

{
    "code": 0,
    "message": "",
    "data": {
        "vpnGwId": "vpngw-kfldykuz",
        "vpcConnId": "vpnx-ol6bcqp0",
        "taskId": 12615,
        "state": 4
    }
}