DeleteVpnGateway--VPN连接-火山引擎

文档中心

立即注册

导航

DeleteVpnGateway

最近更新时间：2024.04.18 17:23:56首次发布时间：2022.04.28 07:17:15

调用DeleteVpnGateway删除指定的VPN网关。

调用说明

VPN网关计费类型为按量计费，可直接删除。
VPN网关计费类型为包年包月，仅可删除已到期或已完成退订操作的VPN网关。
被删除VPN网关下不可存在IPsec连接或SSL服务端。请先调用DeleteVpnConnection删除该VPN网关下全部IPsec连接、调用DeleteSslVpnServer删除SSL服务端，然后再删除VPN网关。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DeleteVpnGateway	要执行的操作，取值：DeleteVpnGateway。
Version	String	是	2020-04-01	API版本信息。
VpnGatewayId	String	是	vgw-12bfa2du7fojk17q7y1rk****	待删除VPN网关的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。

返回数据

名称	类型	示例值	描述
RequestId	String	202203211611080102121461940900****	请求ID。
OrderId	String	BO7023270736605810****	订单ID。

请求示例

GET /?Action=DeleteVpnGateway&Version=2020-04-01&VpnGatewayId=vgw-12bfa2du7fojk17q7y1rk**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

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

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidVpnGateway.InvalidStatus	The specified VPN gateway is not in the correct status for the request.	指定的VPN网关所处的状态无法响应该请求。
400	InvalidVpnGateway.InUse	The specified VPN gateway has dependent resource of connection.	指定的VPN网关已被IPsec连接使用，无法删除。
400	InvalidVpnGateway.InvalidBillingType	The specified VPN gateway is not in the correct billing type for the request.	指定的VPN网关所处计费类型无法响应该请求。
400	OrderError	Failed to create an order in one step.	创建订单并支付失败。
400	InvalidVpnGateway.InUse	The specified VPN gateway has related SSL server.	指定的VPN网关存在SSL服务端，无法删除。
404	InvalidVpnGateway.NotFound	The specified VPN gateway does not exist.	指定的VPN网关不存在。
404	InvalidVpnGateway.GetInstanceDetail	Get instance detail failed.	获取实例信息失败。