You need to enable JavaScript to run this app.
文档中心
VPN连接

VPN连接

复制全文
下载 pdf
VPN连接健康检查
ModifyVpnConnectionHealthChecker-更新VPN连接健康检查实例
复制全文
下载 pdf
ModifyVpnConnectionHealthChecker-更新VPN连接健康检查实例
调用ModifyVpnConnectionHealthChecker修改IPsec连接健康检查的信息。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:ModifyVpnConnectionHealthChecker​
要执行的操作,取值:ModifyVpnConnectionHealthChecker。​
​
Version String 必选 示例值:2020-04-01​
API版本信息。​
​
CheckerId String 必选 示例值:vhc-fsej4fhk0lw****​
IPsec连接健康检查的ID。您可调用DescribeVpnConnections查询IPsec连接健康检查的ID。​
​
VpnConnectionId String 可选 示例值:vgc-3tex2x1cwd4c6c0v****​
待修改健康检查所属IPsec连接的ID。您可调用DescribeVpnConnections查询IPsec连接的ID。​
​
LocalIp String 可选 示例值:100.XX.XX.10​
健康检查的源IP。​
  • 不支持169.254.0.0/16、224.0.0.0/3、127.0.0.0/8网段内的IP。​
  • 同一个VPN网关下有多个IPsec连接需要开启健康检查时,请使用不同的源IP来区分。​
  • 不填保持原有配置。​
​
RemoteIp String 可选 示例值:100.XX.XX.10​
健康检查的目的IP。​
  • 目的IP不可与源IP相同,不支持169.254.0.0/16、224.0.0.0/3、127.0.0.0/8网段内IP。​
  • 不填保持原有配置。​
​
CheckInterval Integer 可选 示例值:3​
执行健康检查的时间间隔,​
  • 取值范围为1 ~ 300,单位:秒。​
  • 不填保持原有配置。​
​
UpTime Integer 可选 示例值:3​
健康检查的健康阈值。​
  • 取值范围:1 ~ 10,单位:次。​
  • 不填保持原有配置。​
​
DownTime Integer 可选 示例值:3​
健康检查的不健康阈值。​
  • 取值范围:1 ~ 10,单位:次。​
  • 不填保持原有配置。​
​
Timeout Integer 可选 示例值:2​
健康检查的响应超时时间。表示当IPsec连接在指定的时间内没有正确响应,则判定为健康检查“异常”。​
  • 取值范围:1 ~ 300,且需要小于CheckInterval的值。单位:秒。​
  • 不填保持原有配置。​
​
ClientToken String 可选 示例值:123e4567-e89b-12d3-a456-42665544****​
客户端Token,用于保证请求幂等性。​
  • 由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。​
  • 仅支持ASCII字符,且不能超过64个字符。​
  • 若不传入ClientToken,则此次API调用不进行幂等校验。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId String 可选 示例值:0ED8D006-F706-4D23-88ED-E11ED28D****​
请求ID。​
​
​
请求示例​
​
GET /?Action=ModifyVpnConnectionHealthChecker&Version=2020-04-01&CheckerId=vhc-2fewk20sch0qo59gp674****&LocalIp=172.XX.XX.108&RemoteIp=172.XX.XX.253&VpnConnectionId=vgc-3tex2x1cwd4c6c0v****&CheckInterval=5&UpTime=1&DownTime=7&Timeout=3 HTTP/1.1​
Host: vpn.cn-beijing.volcengineapi.com​
X-Date: 20251029T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251029/cn-beijing/vpn/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20240318145124A933E01C1C38EB8****",​
"Action": "ModifyVpnConnectionHealthChecker",​
"Version": "2020-04-01",​
"Service": "vpn",​
"Region": "cn-beijing"​
},​
"Result": {​
"RequestId": "20240318145124A933E01C1C38EB84****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
IdempotentParameterMismatch​
Arguments on this idempotent request are inconsistent with arguments used in previous request(s).​
此幂等请求的参数与前一个请求中使用的参数不一致。​
400​
InvalidCheckInterval.Malformed​
The specified check interval is malformed.​
指定的check interval不合法。​
400​
InvalidDownTime.Malformed​
The specified check downtime is malformed.​
指定的check downtime不合法。​
400​
InvalidHealthCheckConfig.IpPairExists​
The specified local ip and remote ip is the same with that of another health checker in the same VPN connection.​
指定的local ip和remote ip和此IPSec连接的其他健康检查相同。​
400​
InvalidHealthCheckConfig.LocalIpConflict​
The specified local ip conflicts with that of another health checker in the same VPN gateway.​
指定的local ip和此网关其他健康检查冲突。​
400​
InvalidHealthCheckConfig.RemoteIpConflict​
The specified remote ip conflicts with that of another health checker in the same VPN gateway.​
指定的remote ip和此网关其他健康检查冲突。​
400​
InvalidHealthCheckConfig.RemoteIpInUse​
The specified remote ip conflicts with the address used in the VPN gateway.​
指定的remote ip和此网关本地ip冲突。​
400​
InvalidHeathCheckConfig.LocalIpInUse​
The specified local ip conflicts with the address used in the VPN gateway.​
指定的local ip和此网关本地ip冲突。​
400​
InvalidLocalIp.Malformed​
The specified local IP is malformed.​
指定的local ip不合法。​
400​
InvalidParameter.ClientTokenMalformed​
The specified parameter ClientToken is malformed.​
指定的参数ClientToken格式不合法,长度不能超过64个ASCII字符。​
400​
InvalidRemoteIp.Malformed​
The specified remote ip is malformed.​
指定的remote ip不合法。​
400​
InvalidTimeout.Malformed​
The specified check timeout is malformed.​
指定的check timeout不合法。​
400​
InvalidUpTime.Malformed​
The specified check uptime is malformed.​
指定的check uptime不合法。​
400​
InvalidVpnConnection.HealthCheckNotSupported​
Health check is not supported for the specified VPN connection.​
当前IPSec连接不支持健康检查功能。​
400​
InvalidVpnConnection.InvalidStatus​
The specified VPN connection is not in the correct status for the request.​
指定的VPN连接所处的状态无法响应该请求。​
400​
InvalidVpnGateway.InvalidStatus​
The specified VPN gateway is not in the correct status for the request.​
指定的VPN网关所处的状态无法响应该请求。​
400​
InvalidHealthCheckConfig.IpPairMalformed​
The specified remote ip is the same with the local ip.​
健康检查指定的remote ip和local ip重复。​
400​
InvalidHealthCheckConfig.IpNotInTrafficSelector​
The specified local ip or remote ip is not within the configured traffic selector.​
健康检查的 local ip 或 remote ip 不在配置的 Traffic Selector 范围内。​
404​
InvalidVpnConnection.NotFound​
The specified IPSec connection does not exist.​
指定的IPSec连接不存在。​
404​
InvalidVpnConnectionHealthChecker.NotFound​
The specified VPN connection health checker does not exist.​
指定的VPN连接健康检查不存在。​
412​
IdempotentProcessing​
The request uses the same client token as a previous one that is still in process.​
幂等请求处理中。​
​
最近更新时间:2026.02.02 11:15:04
这个页面对您有帮助吗?
有用
有用
无用
无用