调用CreateVpnAttachment接口创建IPsec连接,用于绑定转发路由器实例。

使用说明

调用CreateVpnAttachment接口创建的IPsec连接默认未绑定任何资源,后续您可以通过调用CreateTransitRouterVpnAttachment接口将IPsec连接绑定转发路由器实例。

前提条件

创建IPsec连接前,请确保您已经在IPsec连接所在的地域创建了用户网关。具体操作,请参见CreateCustomerGateway

如果您需要为IPsec连接添加BGP配置,请确保用户网关已添加了自治系统号。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

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

系统规定参数。取值:CreateVpnAttachment

RegionId String ap-southeast-2

IPsec连接所属的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

Name String nametest

IPsec连接的名称。

名称长度为1~100个字符,不能以http://https://开头。

CustomerGatewayId String cgw-p0w2jemrcj5u61un8****

用户网关ID。

NetworkType String public

IPsec连接的网络类型。取值:

  • public(默认值):公网,表示IPsec连接通过公网建立加密通信通道。
  • private:私网,表示IPsec连接通过私网建立加密通信通道。
LocalSubnet String 10.1.1.0/24,10.1.2.0/24

需要和本地数据中心互通的VPC侧的网段,用于第二阶段协商。

多个网段之间用半角逗号(,)分隔,例如:192.168.1.0/24,192.168.2.0/24。

关于IPsec连接路由模式的说明:

  • 如果LocalSubnetRemoteSubnet均输入为0.0.0.0/0,则表示您使用目的路由模式。
  • 如果LocalSubnetRemoteSubnet均输入具体的网段,则表示您使用感兴趣流模式。
RemoteSubnet String 10.1.3.0/24,10.1.4.0/24

需要和VPC互通的本地数据中心侧的网段,用于第二阶段协商。

多个网段之间用半角逗号(,)分隔,例如:192.168.3.0/24,192.168.4.0/24。

关于IPsec连接路由模式的说明:

  • 如果LocalSubnetRemoteSubnet均输入为0.0.0.0/0,则表示您使用目的路由模式。
  • 如果LocalSubnetRemoteSubnet均输入具体的网段,则表示您使用感兴趣流模式。
EffectImmediately Boolean false

选择IPsec连接的配置是否立即生效。 取值:

  • true:是,配置完成后系统立即进行IPsec协议协商。
  • false(默认值):否,当有流量进入时系统才进行IPsec协议协商。
IkeConfig String {"Psk":"1234****","IkeVersion":"ikev1","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400,"LocalId":"47.XX.XX.1","RemoteId":"47.XX.XX.2"}

第一阶段协商的配置信息:

  • IkeConfig.Psk:预共享密钥,用于VPN网关与本地数据中心之间的身份认证。密钥长度为1~100个字符。

    若您未指定预共享密钥,系统会随机生成一个16位的字符串作为预共享密钥。您可以调用DescribeVpnConnection接口查询系统自动生成的预共享密钥。
    说明 IPsec连接侧的预共享密钥需和本地数据中心侧的认证密钥一致,否则本地数据中心和VPN网关之间无法建立连接。
  • IkeConfig.IkeVersion:IKE协议的版本。取值:ikev1ikev2。默认值:ikev1
  • IkeConfig.IkeMode:协商模式。取值:mainaggressive。默认值:main
  • IkeConfig.IkeEncAlg:第一阶段协商的加密算法。取值:aesaes192aes256des3des。默认值:aes
  • IkeConfig.IkeAuthAlg:第一阶段协商的认证算法。取值:md5sha1。默认值:md5
  • IkeConfig.IkePfs:第一阶段协商使用的Diffie-Hellman密钥交换算法。取值:group1group2group5group14。默认值:group2
  • IkeConfig.IkeLifetime:第一阶段协商出的SA的生存周期。单位:秒。取值范围:0~86400。默认值:86400
  • IkeConfig.LocalId:IPsec连接阿里云侧的标识,长度限制为100个字符。默认值为空。
  • IkeConfig.RemoteId:IPsec连接本地数据中心侧的标识,长度限制为100个字符,默认值为用户网关的IP地址。
IpsecConfig String {"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}

第二阶段协商的配置信息:

  • IpsecConfig.IpsecEncAlg:第二阶段协商的加密算法。取值:aesaes192aes256des3des。默认值:aes
  • IpsecConfig. IpsecAuthAlg:第二阶段协商的认证算法。取值:md5sha1。默认值:md5
  • IpsecConfig. IpsecPfs:第二阶段协商使用的Diffie-Hellman密钥交换算法。取值:disabledgroup1group2group5group14。默认值:group2
  • IpsecConfig. IpsecLifetime:第二阶段协商出的SA的生存周期。单位:秒。取值范围:0~86400。默认值:86400
BgpConfig String {"EnableBgp":"true","LocalAsn":"45104","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"}

BGP的配置信息:

  • BgpConfig.EnableBgp:是否开启BGP功能。取值:truefalse(默认值)。
  • BgpConfig.LocalAsn:阿里云侧的自治系统号。自治系统号取值范围:1~4294967295。默认值:45104
  • BgpConfig.TunnelCidr:IPsec隧道网段。该网段需是一个在169.254.0.0/16内的掩码长度为30的网段。
  • LocalBgpIp:阿里云侧的BGP地址。该地址为IPsec隧道网段内的一个IP地址。
说明
  • 在添加BGP配置前,建议您先了解BGP动态路由功能的工作机制和使用限制。更多信息,请参见BGP动态路由公告
  • 建议您使用自治系统号的私有号码与阿里云建立BGP连接。自治系统号的私有号码范围请自行查阅文档。
HealthCheckConfig String {"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3","Policy": "revoke_route"}

健康检查配置信息:

  • HealthCheckConfig.enable:是否开启健康检查,取值:truefalse(默认值)。
  • HealthCheckConfig.dip:健康检查的目的IP地址。输入VPC侧通过IPsec连接可以访问的本地数据中心的IP地址。
  • HealthCheckConfig.sip:健康检查的源IP地址。输入本地数据中心通过IPsec连接可以访问的VPC侧的IP地址。
  • HealthCheckConfig.interval:健康检查的重试间隔时间,单位:秒。默认值:3
  • HealthCheckConfig.retry:健康检查的重试发包次数。默认值:3
  • HealthCheckConfig.Policy:健康检查失败时是否撤销已发布的路由。取值:
    • revoke_route(默认值):撤销已发布的路由。
    • reserve_route:不撤销已发布的路由。
AutoConfigRoute Boolean true

是否自动配置路由。取值:

  • true(默认值):自动配置路由。
  • false:不自动配置路由。
EnableDpd Boolean true

是否开启DPD(对等体存活检测)功能。取值:

  • true(默认值):开启DPD功能。IPsec发起端会发送DPD报文用来检测对端的设备是否存活,如果在设定时间内未收到正确回应则认为对端已经断线,IPsec将删除ISAKMP SA和相应的IPsec SA,安全隧道同样也会被删除。
  • false:不开启DPD功能,IPsec发起端不会发送DPD探测报文。
EnableNatTraversal Boolean true

是否开启NAT穿越功能。取值:

  • true(默认值):开启NAT穿越功能。开启后,IKE协商过程会删除对UDP端口号的验证过程,同时实现对VPN隧道中NAT网关设备的发现功能。
  • false:不开启NAT穿越功能。
RemoteCaCert String -----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----

国密型VPN网关创建IPsec连接时,对端的CA证书。

ClientToken String 123e4567-e89b-12d3-a456-4266****

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

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。

返回数据

名称 类型 示例值 描述
RequestId String 88187252-0E26-3C4D-9D1D-32A04454EBBA

请求ID。

VpnConnectionId String vco-p0wb09rama8qwwgfn****

IPsec连接ID。

Name String nametest

IPsec连接的名称。

CreateTime Long 1658201810000

创建IPsec连接的时间戳。单位:毫秒。

时间戳的格式采用Unix时间戳,表示从格林威治时间1970年01月01日00时00分00秒至创建IPsec连接时的总时长。

Code String 200

当前任务返回的状态码。200表示任务成功。

Success Boolean true

当前任务是否成功执行。

  • true:已成功执行。
  • false:未能成功执行。
Message String successful

当前任务返回的信息。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateVpnAttachment
&RegionId=ap-southeast-2
&Name=nametest
&CustomerGatewayId=cgw-p0w2jemrcj5u61un8****
&NetworkType=public
&LocalSubnet=10.1.1.0/24,10.1.2.0/24
&RemoteSubnet=10.1.3.0/24,10.1.4.0/24
&EffectImmediately=false
&IkeConfig={"Psk":"1234****","IkeVersion":"ikev1","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400,"LocalId":"47.XX.XX.1","RemoteId":"47.XX.XX.2"}
&IpsecConfig={"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
&BgpConfig={"EnableBgp":"true","LocalAsn":"45104","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"}
&HealthCheckConfig={"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3","Policy": "revoke_route"}
&AutoConfigRoute=true
&EnableDpd=true
&EnableNatTraversal=true
&ClientToken=123e4567-e89b-12d3-a456-4266****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateVpnAttachmentResponse>
    <RequestId>88187252-0E26-3C4D-9D1D-32A04454EBBA</RequestId>
    <VpnConnectionId>vco-p0wb09rama8qwwgfn****</VpnConnectionId>
    <Name>nametest</Name>
    <CreateTime>1658201810000</CreateTime>
    <Code>200</Code>
    <Success>true</Success>
    <Message>successful</Message>
</CreateVpnAttachmentResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "88187252-0E26-3C4D-9D1D-32A04454EBBA",
  "VpnConnectionId" : "vco-p0wb09rama8qwwgfn****",
  "Name" : "nametest",
  "CreateTime" : 1658201810000,
  "Code" : "200",
  "Success" : true,
  "Message" : "successful"
}

错误码

HttpCode 错误码 错误信息 描述
400 VpnRouteEntry.AlreadyExists The specified route entry is already exist. 该路由已存在。
400 VpnRouteEntry.Conflict The specified route entry has conflict. 路由条目存在冲突。
400 NotSupportVpnConnectionParameter.IpsecPfs The specified vpn connection ipsec Ipsec Pfs is not support. IPsec连接中指定的Pfs参数不支持
400 NotSupportVpnConnectionParameter.IpsecAuthAlg The specified vpn connection ipsec Auth Alg is not support. IPsec连接中指定的认证算法不支持
400 VpnRouteEntry.BackupRoute Validate backup route entry failed. 主备路由条目校验失败。
400 VpnRouteEntry.InvalidWeight Invalid route entry weight value. 路由权重值不合法
400 InvalidParameter.VpnConnectionName The specified vpn connection name is invalid. 指定的VPN连接名称不合规范。
400 QuotaExceeded.PolicyBasedRoute The maximum number of policy-based routes is exceeded. Existing routes: %s. Routes to be created: %s. Maximum routes: %s. 策略路由条数已达上限,当前已有%s条,本次将创建%s条,上限为%s条。
400 MissingParam.CustomerGatewayAsn Asn of customer gateway is mandatory when BGP is enabled. 开启BGP时,客户网关的自治系统号不可以为空。
400 IllegalParam.LocalSubnet The specified "LocalSubnet" (%s) is invalid. 本端网段(%s)不合法。
400 IllegalParam.RemoteSubnet The specified "RemoteSubnet" (%s) is invalid. 对端网段(%s)不合法。
400 MissingParam.RemoteId The remote ID is mandatory when creating national standard VPN connection. 当创建国密VPN连接时,对端ID是必填参数。
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user. 您没有权限操作该资源,请您申请操作权限后再试。
403 Forbidden User not authorized to operate on the specified resource. 您没有权限操作指定资源,请申请权限后再操作。
404 InvalidCustomerGatewayInstanceId.NotFound The specified customer gateway instance id does not exist. 指定的用户网关实例不存在,请您检查用户网关实例ID是否正确。

访问错误中心查看更多错误码。