VpnConnectionName

String

否

IPsecVPN-10wd

IPsec连接的名称。

• 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。
• 长度限制为1 ~ 128个字符。
• 不填默认为IPsec连接的ID。

Description

String

否

test

IPsec连接的描述信息。

• 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。
• 长度限制为0 ~ 255个字符。
• 不填默认为空字符串。

AttachType

String

否

VpnGateway

IPsec连接关联的资源类型。

• VpnGateway（默认）：VPN网关
• TransitRouter：中转路由器

VpnGatewayId

String

否

vgw-3tex2x1cwd4c6c0v****

IPsec连接关联的VPN网关的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。

LocalSubnet.N

String

是

IPsec连接的本端网段。

• 参数 - N表示本端网段的序号。
• 最多支持传入5个网段。
• 多个网段之间用&分隔。

RemoteSubnet.N

String

是

IPsec连接的对端网段。

• 参数 - N表示对端网段的序号。
• 最多支持传入5个网段。
• 多个网段之间用&分隔。

IkeConfig

List of String

是

IPsec连接中IKE配置的信息。其中参数IkeConfig.Psk为必填参数，其他参数均为非必填参数。

• IkeConfig.Psk：预共享密钥，用于第一阶段VPN网关与用户网关之间的身份认证。长度不超过100个字符，只可输入大小写字母、特殊符号~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \ , . / : ;以及数字。
• IkeConfig.Version：IKE密钥交换协议的版本。取值如下
  • ikev1
  • ikev2（默认）
• IkeConfig.Mode：第一阶段的协商模式。仅IkeConfig.Version为ikev1时需传入本参数。取值如下：
  • main（默认）
  • aggressive
• IkeConfig.EncAlg：第一阶段协商的加密算法。取值如下：
  • aes（默认）
  • aes192
  • aes256
  • des
  • 3des
  • sm4
• IkeConfig.AuthAlg：第一阶段的认证算法。取值如下：
  • sha1（默认）
  • md5
  • sha256
  • sha384
  • sha512
  • sm3
• IkeConfig.DhGroup：第一阶段协商使用的DH（Diffie-Hellman）密钥交换算法。取值如下：
  • group1
  • group2（默认）
  • group5
  • group14
• IkeConfig.Lifetime：第一阶段协商的SA的生存时间，超过生存时间后，将重新发起协商。
  • 取值范围：900~86400，单位：秒。
  • 默认：86400。
• IkeConfig.LocalId：VPN网关的标识，用于第一阶段的协商，支持IP格式和FQDN( Fully Qualified Domain Name)完全合格域名/全称域名格式。
  • 不传默认为当前所选VPN网关的出口IP地址。
  • 若您手动设置为FQDN格式，协商模式推荐设置为“aggressive”。
  • 长度不超过100个字符，只可输入大小写字母、特殊符号~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \ , . / : ;以及数字。
• IkeConfig.RemoteId：用户网关的标识，用于第一阶段的协商，支持IP格式和FQDN( Fully Qualified Domain Name)完全合格域名/全称域名格式。
  • 不传默认为当前所选用户网关的公网IP地址。
  • 若您手动设置为FQDN格式，协商模式推荐设置为“aggressive”。
  • 长度不超过100个字符，只可输入大小写字母、特殊符号~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \ , . / : ;以及数字。

IpsecConfig

List of String

否

IPsec连接中的IPsec配置的信息，包含如下参数：

• IpsecConfig.EncAlg：第二阶段协商的加密算法。取值如下：
  • aes（默认）
  • aes192
  • aes256
  • des
  • 3des
  • sm4
• IpsecConfig.AuthAlg：第二阶段协商的认证算法。取值如下：
  • sha1（默认）
  • md5
  • sha256
  • sha384
  • sha512
  • sm3
• IpsecConfig.DhGroup：第二阶段使用的DH（Diffie-Hellman）密钥交换算法。取值如下：
  • group1
  • group2（默认）
  • group5
  • group14
  • disable（不配置DH算法）

• IpsecConfig.Lifetime：第二阶段协商的SA的生存时间，超过生存时间后，将重新发起协商。
  • 取值范围：900~86400
  • 单位：秒。
  • 默认：86400。

NatTraversal

Boolean

否

false

是否开启NAT穿越功能。

• true：开启。NAT穿越（NAT Traversal）功能开启后，IKE协商时不会对UDP端口号进行验证，并且能够发现VPN连接隧道中NAT网关设备。
• false（默认）：不开启。

DpdAction

String

否

clear

DPD功能的状态。

• none：关闭DPD功能。
• clear（默认）：开启DPD功能，DPD超时后清除IKE SA。
• hold：开启DPD功能，DPD超时后保持当前状态，等待新的流量进入后重新建立连接。
• restart：开启DPD功能，DPD超时后立即重连。

ClientToken

String

否

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

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

• 由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
• 仅支持ASCII字符，且不能超过64个字符。
• 若不传入ClientToken，则此次API调用不进行幂等校验。

NegotiateInstantly

Boolean

否

true

是否立即发起协商模式。

• true：IPsec连接配置完成后系统立即主动发起协商。
• false（默认）：IPsec连接配置完成后系统不主动发起协商，当有流量通过时被动发起协商。

LogEnabled

Boolean

否

false

是否启用连接日志。启用连接日之后，您可查看、下载IPsec连接日志，并通过日志信息自行排查IPsec连接的故障问题。

• true：启用。
• false：不启用。

Spec

String

否

default

IPsec连接实例规格，仅关联TR实例的IPsec生效，关联VPN网关实例的IPsec无效，即AttachType传入TransitRouter时此参数才生效。

• default（默认）：默认规格，带宽上限为200 Mbps。
• large：大型规格，带宽上限为1 Gbps。

BgpConfig.EnableBgp

Bool

否

True

是否开启动态路由传播功能。

• false（默认）：否，使用静态路由模式。
• true：是，使用BGP路由模式。

BgpConfig.TunnelCidr

String

否

169.254.XX.XX/30

隧道网段，是BGP 会话本端IP和对端IP所在的 CIDR 地址段。

• 该地址段需要在 169.254.0.0/16 网段内、掩码长度为 /30 的网段，且不可在169.254.255.0/24网段内。
• 如果BgpConfig.EnableBgp传入值为true，此参数需必须填写。

BgpConfig.LocalBgpIp

String

否

169.254.XX.XX

本端隧道IP，是配置在VPN网关上的BGP地址

• 默认为BgpConfig.TunnelCidr的第一个主机地址。
• 该地址必须为 IPsec 隧道网段内的一个 IP 地址。
• 如果BgpConfig.EnableBgp传入值为true，此参数需必须填写。