You need to enable JavaScript to run this app.
导航
VPN连接
  • 文档首页
    • /
  • VPN连接

ModifyVpnConnectionHealthChecker

最近更新时间：2024.04.18 17:23:57

首次发布时间：2024.03.22 08:25:16

我的收藏

调用ModifyVpnConnectionHealthChecker修改IPsec连接健康检查的信息。

调试

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

请求参数

名称类型是否必选示例值描述

Action

String

是

ModifyVpnConnectionHealthChecker

要执行的操作，取值：ModifyVpnConnectionHealthChecker。

VersionString是2020-04-01API版本信息。

CheckerId

String

是

vhc-abc

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，默认值为3，单位：秒。

  • 不填保持原有配置。

UpTime

Integer

否

3

健康检查的健康阈值。

  • 取值范围：1 ～ 10，默认值：3，单位：次。

  • 不填保持原有配置。

DownTime

Integer

否

3

健康检查的不健康阈值。

  • 取值范围：1 ～ 10，默认值：3，单位：次。

  • 不填保持原有配置。

Timeout

Integer

否

2

健康检查的响应超时时间。表示当IPsec连接在指定的时间内没有正确响应，则判定为健康检查“异常”。

  • 取值范围：1 ～ 300，且需要小于CheckInterval的值。默认值：1，单位：秒。

  • 不填保持原有配置。

ClientToken

String

否

123e4567-e89b-12d3-a456-42665544****

客户端Token，用于保证请求幂等性。

  • 由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

  • 仅支持ASCII字符，且不能超过64个字符。

  • 若不传入ClientToken，则此次API调用不进行幂等校验。

返回数据

名称类型示例值描述
RequestIdString0ED8D006-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&CheckInterval=5&UpTime=1&DownTime=7&Timeout=3 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240318145124A933E01C1C38EB8****",
        "Action": "ModifyVpnConnectionHealthChecker",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20240318145124A933E01C1C38EB84****"
    }
}

错误码

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

HttpCode错误码错误信息描述
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InvalidCheckInterval.MalformedThe specified check interval is malformed.指定的check interval不合法。
400InvalidDownTime.MalformedThe specified check downtime is malformed.指定的check downtime不合法。
400InvalidHealthCheckConfig.IpPairExistsThe 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连接的其他健康检查相同。
400InvalidHealthCheckConfig.LocalIpConflictThe specified local ip conflicts with that of another health checker in the same VPN gateway.指定的local ip和此网关其他健康检查冲突。
400InvalidHealthCheckConfig.RemoteIpConflictThe specified remote ip conflicts with that of another health checker in the same VPN gateway.指定的remote ip和此网关其他健康检查冲突。
400InvalidHealthCheckConfig.RemoteIpInUseThe specified remote ip conflicts with the address used in the VPN gateway.指定的remote ip和此网关本地ip冲突。
400InvalidHeathCheckConfig.LocalIpInUseThe specified local ip conflicts with the address used in the VPN gateway.指定的local ip和此网关本地ip冲突。
400InvalidLocalIp.MalformedThe specified local IP is malformed.指定的local ip不合法。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400InvalidRemoteIp.MalformedThe specified remote ip is malformed.指定的remote ip不合法。
400InvalidTimeout.MalformedThe specified check timeout is malformed.指定的check timeout不合法。
400InvalidUpTime.MalformedThe specified check uptime is malformed.指定的check uptime不合法。
400InvalidVpnConnection.HealthCheckNotSupportedHealth check is not supported for the specified VPN connection.当前IPSec连接不支持健康检查功能。
400InvalidVpnConnection.InvalidStatusThe specified VPN connection is not in the correct status for the request.指定的VPN连接所处的状态无法响应该请求。
400InvalidVpnGateway.InvalidStatusThe specified VPN gateway is not in the correct status for the request.指定的VPN网关所处的状态无法响应该请求。
400InvalidHealthCheckConfig.IpPairMalformedThe specified remote ip is the same with the local ip.健康检查指定的remote ip和local ip重复。
404InvalidVpnConnectionHealthChecker.NotFoundThe specified VPN connection health checker does not exist.指定的VPN连接健康检查不存在。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。