ResetVpnConnection--VPN连接-火山引擎

文档中心

立即注册

导航

ResetVpnConnection

最近更新时间：2024.08.09 15:51:25首次发布时间：2024.05.17 08:25:51

调用ResetVpnConnection重置IPsec连接隧道。

调用说明

仅可重置已有的IPsec连接隧道，未关联中转路由器（TR）的TR类型IPsec连接不可重置IPsec连接隧道。
重置IPsec连接后会中断现有的IPsec连接隧道数据传输，为避免重置隧道对业务造成影响，请在业务空闲时操作。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ResetVpnConnection	要执行的操作，取值：ResetVpnConnection。
Version	String	是	2020-04-01	API版本信息。
VpnConnectionId	String	是	vgc-2bzvqi8kerd342dx0eg2f****	需要重置隧道的IPsec连接的ID
ClientToken	String	否	02fb3da4-130e-11e9-8e44-0016e04****	客户端Token，用于保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。仅支持ASCII字符，且不能超过64个字符。若不传入ClientToken，则此次API调用不进行幂等校验。

返回数据

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

请求示例

GET /?Action=ResetVpnConnection&Version=2020-04-01&VpnConnectionIds=vgc-2bzvqi8kerd342dx0eg2f**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

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

错误码

HttpCode	错误码	错误信息	描述
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
400	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400	InvalidVpnConnection.AttachStatus	The operation is not supported by the current VPN connection attach status.	当前操作不支持，请稍后重试。
400	InvalidVpnConnection.InvalidStatus	The specified VPN connection is not in the correct status for the request.	指定的VPN连接所处的状态无法响应该请求。
403	Forbidden.VpnConnectionBlocked	The specified TR IPsec is blocked.	当前TR IPsec封禁中，禁止操作。
403	Forbidden.VpnGatewayBlocked	The specified VPN gateway is blocked.	当前VPN网关封禁中，禁止操作。
404	InvalidVpnConnection.NotFound	The specified IPSec connection does not exist.	指定的IPSec连接不存在。
404	InvalidVpnGateway.NotFound	The specified VPN gateway does not exist.	指定的VPN网关不存在。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。
412	InvalidVpnConnection.AccountInArrears	The specified IPSec connection has been shut down due to the account in arrears status.	指定的IPSec连接已欠费关停。
412	InvalidVpnGateway.Expired	The specified VPN gateway has expired.	指定的VPN网关已过期。