删除VPN通道
最近更新时间: 2024-10-17 17:10:00
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. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见公共错误码。
错误码 | 描述 |
---|---|
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
}
}