调用CreateVpnConnection创建一个新的IPsec连接。
LocalSubnet
与RemoteSubnet
都传入0.0.0.0/0
。名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateVpnConnection | 要执行的操作,取值:CreateVpnConnection。 |
Version | String | 是 | 2020-04-01 | API版本信息。 |
VpnConnectionName | String | 否 | IPsecVPN-10wd | IPsec连接的名称。
|
Description | String | 否 | test | IPsec连接的描述信息。
|
AttachType | String | 否 | VpnGateway | IPsec连接关联的资源类型。
|
VpnGatewayId | String | 否 | vgw-3tex2x1cwd4c6c0v**** | IPsec连接关联的VPN网关的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。 说明 若 |
CustomerGatewayId | String | 是 | cgw-3tehy13n2l4c6c0v**** | IPsec连接关联的用户网关的ID。若传入的用户网关的IP地址为0.0.0.0 ,则NegotiateInstantly 仅可传入false,IkeConfig 中IkeConfig.Version 仅可传入ikev1且IkeConfig.Mode 仅可传入aggressive。您可调用DescribeCustomerGateways查询用户网关的ID信息。 |
LocalSubnet.N | List of String | 是 | LocalSubnet.1=10.0.XX.0/24&LocalSubnet.2=10.0.XX.0/24 | IPsec连接的本端网段。
|
RemoteSubnet.N | List of String | 是 | RemoteSubnet.1=172.16.XX.0/24&RemoteSubnet.2=172.16.XX.0/24 | IPsec连接的对端网段。
|
IkeConfig | List of String | 是 | IkeConfig.Psk=Test123***&IkeConfig.Version=v1&IkeConfig.Mode=main&IkeConfig.EncAlg=aes&IkeConfig.AuthAlg=sha1&IkeConfig.DhGroup=group2&IkeConfig.Lifetime=86400 | IPsec连接中IKE配置的信息。其中参数 说明 若传入的用户网关的IP地址为
|
IpsecConfig | List of String | 否 | IpsecConfig.EncAlg=aes&IpsecConfig. AuthAlg=sha1&IpsecConfig. DhGroup=group2&IpsecConfig.Lifetime=86400 | IPsec连接中的IPsec配置的信息,包含如下参数:
说明 若选择group1、group2、group5、group14,将默认开启PFS(Perfect Forward Secrecy)完美前向保密功能,对应的客户端也需要开启PFS功能。若客户端不支持PFS功能,此处需配置为“disable”。
|
NatTraversal | Boolean | 否 | false | 是否开启NAT穿越功能。
|
DpdAction | String | 否 | clear | DPD功能的状态。
|
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-42665544**** | 客户端Token,用于保证请求幂等性。
|
ProjectName | String | 否 | Project_1 | IPsec连接所属的项目。不填默认为default,即创建的资源属于default项目。您可调用ListProjects查询当前账号下项目的信息。 |
NegotiateInstantly | Boolean | 否 | true | 是否立即发起协商模式。 说明 若传入的用户网关的IP地址为
|
LogEnabled | Boolean | 否 | false | 是否启用连接日志。启用连接日之后,您可查看、下载IPsec连接日志,并通过日志信息自行排查IPsec连接的故障问题。
说明 启用连接日志前请先确认当前账号已开通日志服务和对象存储服务,并已为VPN连接服务授权跨服务访问日志服务。 |
Spec | String | 否 | default | IPsec连接实例规格,仅关联TR实例的IPsec生效,关联VPN网关实例的IPsec无效,即
说明 1G规格当前为邀测阶段,仅开启后可使用,如需试用请联系客户经理开通。未开通1G规格,此处请不要传入 |
BgpConfig.EnableBgp | Bool | 否 | True | 是否开启动态路由传播功能。
说明 BGP功能当前为邀测阶段,仅开启后可使用BGP功能,如需试用请联系客户经理开通。未开启BGP功能,此处请不要传入 |
BgpConfig.TunnelCidr | String | 否 | 169.254.XX.XX/30 | 隧道网段,是BGP 会话本端IP和对端IP所在的 CIDR 地址段。
|
BgpConfig.LocalBgpIp | String | 否 | 169.254.XX.XX | 本端隧道IP,是配置在VPN网关上的BGP地址
|
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 2022032111142501022524314704AF**** | 请求ID。 |
VpnConnectionId | String | vgc-3tex2x1cwd4c6c0v**** | 新创建IPsec连接的ID。 |
OrderId | String | Order7078570823273845036 | 新创建TR类型IPsec连接的订单ID。 |
GET /?Action=CreateVpnConnection&Version=2020-04-01&VpnConnectionName=test&Description=test&CustomerGatewayId=cgw-274mm8eodvu9s7fap8skw****&VpnGatewayId=vgw-2752abxsju1vk7fap8sgk****&LocalSubnet=192.168.XX.XX/16&RemoteSubnet=172.16.XX.XX/16&IKEConfig.Psk=12345&IKEConfig.Version=ikev2&IKEConfig.EncAlg=aes&IPSecConfig.DhGroup=disable HTTP/1.1 Host: open.volcengineapi.com ServiceName: vpn Region: cn-beijing
{ "ResponseMetadata":{ "RequestId":"2022032111142501022524314704AF****", "Action":"CreateVpnConnection", "Version":"2020-04-01", "Service":"vpn", "Region":"cn-beijing" }, "Result":{ "RequestId":"2022032111142501022524314704AF****", "VpnConnectionId":"vgc-2bzvqi8kerd342dx0eg2f****" } }
此处仅展示当前API的错误码,更多错误码请参见公共错误码。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidName.Malformed | The specified name is malformed.Ensure the maximum length of name is 128. | 指定的名称格式不合法。名称长度不能超过128个字符。 |
400 | InvalidName.Malformed | The specified name is malformed. | 指定的名称格式不合法。请修复名称格式后重试。 |
400 | InvalidDescription.Malformed | The specified description is malformed.Ensure the maximum length of description is 255. | 指定的描述格式不合法。描述长度不能超过255个字符。 |
400 | InvalidDescription.Malformed | The specified description is malformed. | 指定的描述格式不合法。请修复描述格式后重试。 |
400 | InvalidVpnConnectionLocalSubnet.Malformed | The specified LocalSubnet is malformed. | 指定的本端网段不合法。 |
400 | InvalidVpnConnectionRemoteSubnet.Malformed | The specified RemoteSubnet is malformed. | 指定的对端网段不合法。 |
400 | InvalidVpnConnectionIKEPsk.Malformed | The specified IKE Psk is malformed. Ensure the maximum length of IKE Psk is 100. | 指定的IKE Psk格式不合法。IKE Psk长度不能超过100个字符。 |
400 | InvalidVpnConnectionIKEPsk.Malformed | The specified IKE Psk is malformed. | 指定的IKE Psk不合法。 |
400 | InvalidVpnConnectionIKEAuthElg.Malformed | The specified IKE AuthAlg is malformed. | 指定的IKE AuthAlg不合法。 |
400 | InvalidVpnConnectionIKEEncElg.Malformed | The specified IKE EncAlg is malformed. | 指定的IKE EncAlg不合法。 |
400 | InvalidVpnConnectionIKEDhGroup.Malformed | The specified IKE DhGroup is malformed. | 指定的IKE DhGroup不合法。 |
400 | InvalidVpnConnectionIKEMode.Malformed | "The specified IKE Mode is malformed. | 指定的IKE Mode不合法。 |
400 | InvalidVpnConnectionIKEVersion.Malformed | The specified IKE Version is malformed. | 指定的IKE Version不合法。 |
400 | InvalidVpnConnectionIKELocalID.Malformed | The specified IKE LocalId is malformed. Ensure the maximum length of IKE LocalId is 100. | 指定的IKE LocalId格式不合法。IKE LocalId长度不能超过100个字符。 |
400 | InvalidVpnConnectionIKELocalID.Malformed | The specified IKE LocalId is malformed. | 指定的IKE LocalId不合法。 |
400 | InvalidVpnConnectionIKERemoteID.Malformed | The specified IKE RemoteId is malformed. Ensure the maximum length of IKE RemoteId is 100. | 指定的IKE RemoteId格式不合法。IKE RemoteId长度不能超过100个字符。 |
400 | InvalidVpnConnectionIKERemoteID.Malformed | The specified IKE RemoteId is malformed. | 指定的IKE RemoteId不合法。 |
400 | InvalidVpnConnectionIKELifetime.Malformed | The specified IKE Lifetime is malformed. | 指定的IKE Lifetime 不合法。 |
400 | InvalidVpnConnectionIPSecAuthElg.Malformed | The specified IPSec AuthAlg is malformed. | 指定的IPSec AuthAlg不合法。 |
400 | InvalidVpnConnectionIPSecEncElg.Malformed | The specified IPSec EncAlg is malformed. | 指定的IPSec EncAlg不合法。 |
400 | InvalidVpnConnectionIPSecDhGroup.Malformed | The specified IPSec DhGroup is malformed. | 指定的IPSec DhGroup不合法。 |
400 | InvalidVpnConnectionIPSecLifetime.Malformed | The specified IPSec Lifetime is malformed. | 指定的IPSec Lifetime不合法。 |
400 | QuotaExceeded.VpnConEachVPNGateway | You've reached the limit on the number of IPSec connections per VPN gateway that you can create. | 已达到每个VPN网关可创建的IPSec连接的数量上限。 |
400 | QuotaExceeded.LocCIDREachVpnCon | You've reached the limit on the number of local subnet per IPSec connection that you can create. | 已达到每个IPSec连接可创建的本端网段数量上限。 |
400 | QuotaExceeded.RemCIDREachVpnCon | You've reached the limit on the number of remote subnet per IPSec connection that you can create. | 已达到每个IPSec连接可创建的对端网段数量上限。 |
400 | InvalidVpnConnectionDpdAction.Malformed | The specified DpdAction is malformed. | 指定的DpdAction不合法。 |
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 | InvalidVpnGateway.FirmwareNotSupported | The specified features aren't supported by the VPN gateway, please upgrade your VPN gateway. | VPN网关不支持所选择的功能,请升级您的VPN网关。 |
400 | InsufficientResource.VpnConnection | The specified region does not have enough resources for IPSec connection. | IPSec连接可用资源不足。 |
400 | InvalidVpnConnectionAttachType.Malformed | The specified AttachType is malformed. | 指定的绑定资源类型不合法。 |
400 | QuotaExceeded.VpnConAttachTypeTransitRouter | You've reached the limit on the number of Transit Router attach type IPSec connections that you can create. | 已达到绑定类型为中转路由器的IPSec连接的数量上限。 |
400 | OrderError | Failed to create an order in one step. | 创建订单并支付失败。 |
400 | UnsupportedOperation | The request on the specified instance is denied due to the account in arrears status. | 因账户处于欠费状态,对于该实例的操作请求被拒绝。 |
400 | UnsupportedOperation | The request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total. | 因账户余额及可用代金券共不足100元,对于该实例的操作请求被拒绝。 |
400 | InvalidCustomerGateway.InvalidStatus | The specified customer gateway is not in the correct status for the request. | 指定的用户网关所处的状态无法响应该请求。 |
400 | InvalidVpnGateway.InvalidStatus | The specified VPN gateway is not in the correct status for the request. | 指定的VPN网关所处的状态无法响应该请求。 |
400 | InvalidVpnConnectionRemoteId.Conflict | The specified IKE RemoteId conflicts with that of another IPSec connection in the specified VPN gateway. | 指定的IKE RemoteId与本网关下其他IPSec连接存在冲突。 |
400 | InvalidVpnConnection.LogNotSupported | IPSec connection log is not supported in this region. | 当前地域不支持IPSec连接日志功能。 |
400 | LimitExceeded.TLSProject | You've reached the limit on the number of TLS project per region that you can create. | 已达到当前账户在单一地域下可创建的TLS日志项目数量上限。 |
400 | InvalidVpnGateway.IpsecNotEnabled | IPSec of the specified VPN gateway is not enabled. | 当前VPN网关未开启IPSec功能。 |
400 | InsufficientResource.VpnGateway | The specified region does not have enough resources for VPN gateway. | VPN网关可用资源不足。 |
400 | InvalidVpnConnection.RegionNotSupport | VPN connection of Transit Router attach type is not supported in the specified region. | 此地域不支持绑定中转路由器类型的IPSec连接。 |
400 | InvalidVpnConnectionBgpLocalIp.Malformed | The BGP local IP is invalid; it should be within BGP tunnel CIDR and must be a host IP. | 指定的BGP本端地址不合法。 |
400 | InvalidVpnConnectionBgpTunnelCidr.Malformed | The BGP tunnel CIDR is invalid. | 指定的BGP隧道地址不合法。 |
400 | InvalidCustomerGateWay.ASNNotConfigured | The specified Customer gateway does not have an ASN. | 指定的用户网关未配置ASN,无法使用BGP功能。 |
400 | InvalidVpnConnectionBgpTunnelCidr.Conflict | The specified BGP tunnel CIDR has conflicts. | 指定的BGP隧道地址存在冲突。 |
400 | InvalidVpnGateway.ASNNotConfigured | The specified VPN gateway does not have an ASN. | 指定的VPN网关未配置ASN,无法使用BGP功能。 |
400 | InvalidVpnGateway.CustomerGateWayASNDuplicated | The VPN gateway ASN is the same as the customer gateway ASN. | VPN网关的ASN与用户网关的ASN一致,无法使用BGP功能。 |
403 | InvalidVpn.ServiceRoleNotAuthorized | The service role for VPN has not been authorized. | 当前账号尚未授权VPN的服务角色。 |
403 | InvalidVpnConnection.TlsAccessDenied | TLS service access denied. | 当前账号未开通日志服务。 |
403 | InvalidVpnConnection.TlsNotSupport | TLS is not supported in this region. | 当前账号在此地域不支持TLS服务。 |
403 | Forbidden.VpnGatewayBlocked | The specified VPN gateway is blocked. | 当前VPN网关封禁中,禁止操作。 |
403 | Forbidden.VpnBgpPermissionNotGranted | The specified account is not granted VPN BGP permission. | 当前账号未开通VPN支持BGP权限。 |
404 | InvalidProject.NotFound | The specified Project does not exist. | 指定的项目不存在。 |
404 | InvalidVpnGateway.NotFound | The specified VPN gateway does not exist. | 指定的VPN网关不存在。 |
404 | InvalidCustomerGateway.NotFound | The specified customer gateway does not exist. | 指定的用户网关不存在。 |
412 | InvalidVpnGateway.Expired | The specified VPN gateway has expired. | 指定的VPN网关已过期。 |
412 | IdempotentProcessing | The request uses the same client token as a previous one that is still in process. | 幂等请求处理中。 |