DeleteCustomerGateway--VPN连接-火山引擎

文档中心

立即注册

导航

DeleteCustomerGateway

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

调用DeleteCustomerGateway删除指定的用户网关。

调用说明

仅可删除未被IPsec连接使用的用户网关，如被IPsec连接使用，可调用DeleteVpnConnection删除IPsec连接后再删除用户网关。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DeleteCustomerGateway	要执行的操作，取值：DeleteCustomerGateway。
Version	String	是	2020-04-01	API版本信息。
CustomerGatewayId	String	是	cgw-3tex2x1cwd4c6c0v****	待删除的用户网关的ID。您可调用DescribeCustomerGateways查询用户网关的ID信息。

返回数据

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

请求示例

GET /?Action=DeleteCustomerGateway&Version=2020-04-01&CustomerGatewayId=cgw-2d670j2o9lc0058ozfddg**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

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

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidCustomerGateway.InvalidStatus	The specified customer gateway is not in the correct status for the request.	指定的用户网关所处的状态无法响应该请求。
400	InvalidCustomerGateway.InUse	The specified customer gateway has dependent resource of connection.	指定的用户网关已经存在连接，无法删除。
404	InvalidCustomerGateway.NotFound	The specified customer gateway does not exist.	指定的用户网关不存在。