全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

创建VPN通道

最近更新时间:2024-08-28 20:41:37

CreateVpnTunnel

创建VPN通道

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称

类型

必填

描述

Action

String

公共参数,本接口取值:CreateVpnTunnel。

Version

String

公共参数,本接口取值:2016-03-04。

CustomerGatewayId

String

客户网关的ID

VpnGatewayId

String

VPN网关的ID

VpnTunnelName

String

Vpn通道的名称

默认值:Ksc_vpn_tunnel

IpsecAuthenAlgorithm

String

有效值:

  • esp-sha-hmac

  • esp-md5-hmac

  • sha256

  • sha384

  • sha512

  • sm3

默认值:esp-sha-hmac

IpsecEncryAlgorithm

String

有效值:

  • esp-3des

  • esp-aes

  • aes-cbc-192

  • aes-cbc-256

  • esp-des

  • esp-null

默认值:esp-aes

IkeAuthenAlgorithm

String

有效值:

  • md5

  • sha

默认值:md5

IkeEncryAlgorithm

String

有效值:

  • 3des

  • aes

  • aes-cbc-192

  • aes-cbc-256

  • des

  • sm1-cbc-128

默认值:aes

Type

String

客户网关的类型(GreOverIpsec|Ipsec|route_ipsec|ipsec)

OpenHealthCheck

Boolean

开启健康检查

PreSharedKey

String

预共享密钥。对称加密的KEY,VPN端和客户端统一,用户自行填写

IpsecLifetimeSecond

Int

生存周期(S)

IpsecLifetimeTraffic

Int

生存周期(Kb)

IkeDHGroup

String

密钥加密算法的类型(1|2|5|14|24)

默认值:2

EnableNatTraversal

Boolean

是否开启野蛮模式

VpnGreIp

String

GRE模式VPN的IP

HaVpnGreIp

String

GRE模式开启HA模式VPN的IP

CustomerGreIp

String

GRE模式客户的IP

HaCustomerGreIp

String

GRE模式开启HA模式客户的IP

HaMode

String

•高可用模式, active_active (负载) 、active_standby(主备)

LocalPeerIp

String

金山侧互联IP

CustomerPeerIp

String

•客户侧互联IP

IkeVersion

String

••IKE版本

返回参数

参数名称

类型

描述

RequestId

String

请求ID

示例值:e561ad44-247b-4ed7-9bdf-8eee59f7dbfd

VpnTunnel

VpnTunnel

Vpn通道信息

CreateTime

String

创建时间

示例值:2016-05-05 18:27:36

OpenHealthCheck

Boolean

开启健康检查,有效值:false(关闭)、true(开启)。仅VPN网关2.0且目的路由模式支持健康检查,缺省默认false

示例值:false

State

String

Vpn通道的状态

示例值:active

VpnTunnelId

String

Vpn通道的ID

示例值:e561ad44-247b-4ed7-9bdf-8eee59f7dbfd

VpnGreIp

String

GRE模式VPN的IP

示例值:10.0.0.11

Type

String

客户网关的类型

示例值:ipsec

HaMode

String

•高可用模式, active_active (负载) 、active_standby(主备)

示例值:active_active

IkeVersion

String

••IKE版本,v1,v2

示例值:v1

LocalPeerIp

String

金山侧互联IP,路由模式为“目的路由”时必填

示例值:120.0.12.19

CustomerPeerIp

String

•客户侧互联IP,路由模式为“目的路由”时必填

示例值:120.0.12.19

CustomerGreIp

String

GRE模式客户的IP

示例值:10.0.0.13

HaVpnGreIp

String

GRE模式开启HA模式VPN的IP

示例值:10.0.0.12

HaCustomerGreIp

String

GRE模式开启HA模式客户的IP

示例值:10.0.0.14

VpnGatewayId

String

VPN网关的ID

示例值:e561ad44-247b-4ed7-9bdf-8eee59f7dbfd

VpnGatewayVersion

String

VPN网关的版本

示例值:1.0

CustomerGatewayId

String

客户网关的ID

示例值:e561ad44-247b-4ed7-9bdf-8eee59f7dbfd

PreSharedKey

String

预共享密钥。对称加密的KEY,VPN端和客户端统一,用户自行填写

示例值:123456

IkeAuthenAlgorithm

String

IKE认证算法

示例值:md5

IkeDHGroup

String

密钥加密算法的类型

示例值:1

IkeEncryAlgorithm

String

IKE加密算法

示例值:3des

IpsecAuthenAlgorithm

String

Ipsec认证算法

示例值:esp-sha-hmac

IpsecEncryAlgorithm

String

Ipsec加密算法

示例值:esp-3des

IpsecLifetimeSecond

Int

生存周期(S)

示例值:3600

IpsecLifetimeTraffic

Int

生存周期(Kb)

示例值:4608000

VpnTunnelName

String

Vpn通道的名称

示例值:Ksc_vpn_tunnel

VpnGwlName

String

vpn网关名

示例值:Ksc_vpn_tunnel

ExtraCidrSet

String[]

额外的网段,用于VPN和对等连接后的VPC互通或者和云IDC互通

示例值:10.0.0.0/16

NatId

String

Nat的ID

示例值:e561ad44-247b-4ed7-9bdf-8eee59f7dbfd

EnableNatTraversal

Boolean

是否开启野蛮模式

示例值:false

请求示例

curl -X POST
'http://vpc.api.ksyun.com/?Action=CreateVpnTunnel&Version=2016-03-04'
-H
'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/x-www-form-urlencoded'
-H 'host: vpc.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'
-d 'CustomerGatewayId=xxx&VpnGatewayId=xxx&VpnTunnelName=Ksc_vpn_tunnel&IpsecAuthenAlgorithm=esp-sha-hmac&IpsecEncryAlgorithm=esp-aes&IkeAuthenAlgorithm=md5&IkeEncryAlgorithm=aes&Type=xxx&OpenHealthCheck=xxx&PreSharedKey=xxx&IpsecLifetimeSecond=xxx&IpsecLifetimeTraffic=xxx&IkeDHGroup=2&EnableNatTraversal=xxx&VpnGreIp=xxx&HaVpnGreIp=xxx&CustomerGreIp=xxx&HaCustomerGreIp=xxx&HaMode=xxx&LocalPeerIp=xxx&CustomerPeerIp=xxx&IkeVersion=xxx'

返回示例

JSON格式

{

"RequestId":"e561ad44-247b-4ed7-9bdf-8eee59f7dbfd",

"VpnTunnel":{

"HaVpnGreIp":"10.0.0.12",

"IpsecLifetimeSecond":3600,

"HaMode":"active_active",

"NatId":"e561ad44-247b-4ed7-9bdf-8eee59f7dbfd",

"CustomerGreIp":"10.0.0.13",

"VpnTunnelName":"Ksc_vpn_tunnel",

"IpsecLifetimeTraffic":4608000,

"HaCustomerGreIp":"10.0.0.14",

"IpsecEncryAlgorithm":"esp-3des",

"VpnGatewayVersion":"1.0",

"IkeAuthenAlgorithm":"md5",

"VpnGreIp":"10.0.0.11",

"EnableNatTraversal":false,

"IkeDHGroup":"1",

"IkeEncryAlgorithm":"3des",

"CustomerGatewayId":"e561ad44-247b-4ed7-9bdf-8eee59f7dbfd",

"IpsecAuthenAlgorithm":"esp-sha-hmac",

"IkeVersion":"v1",

"CreateTime":"2016-05-05 18:27:36",

"OpenHealthCheck":false,

"VpnGwlName":"Ksc_vpn_tunnel",

"CustomerPeerIp":"120.0.12.19",

"Type":"ipsec",

"ExtraCidrSet":[

"10.0.0.0/16"

],

"VpnGatewayId":"e561ad44-247b-4ed7-9bdf-8eee59f7dbfd",

"State":"active",

"PreSharedKey":"123456",

"VpnTunnelId":"e561ad44-247b-4ed7-9bdf-8eee59f7dbfd",

"LocalPeerIp":"120.0.12.19"

}

}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码

错误信息

Http状态码

描述

InvalidRegion

%s region is invalid

400

%s 机房不合法

InvalidId

%s is invalid,%s only allows letters, numbers, - and the length of ID must be 36 digits

400

ID不合法

InvalidValue

%s is invalid

400

%s 不合法

EmptyField

%s can not be empty

400

%s 不能为空

QuotaIdOutRange

<<< %s >>> Quota exceeded Max

400

<<< %s >>>超出配额最大值

InvalidName

%s is invalid,%s only allows letters, numbers, Chinese ,、,/,,(,), - ,_and the max length of Name is 64 digits

400

%s 名称不合法

ApiNotSupportRegion

Region %s does not support this interface.

400

机房 %s 不支持该接口

HeaderEmptyField

Http Header [%s] can not be empty

400

Http Header [%s] 不能为空

SubOrderIdDup

SubOrderId repeat request

400

子订单号被重复调用

ProductTagNotSupport

Special Resource Tag <<< {0} >>> not support operate

400

特殊资源的产品标识 <<< %s >>> 不允许执行此操作

Payment.CreateProductFailed

create product failed

400

创建商品失败

Payment.CreateOrderFailed

create order failed

400

创建订单失败

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈