Create VPN Tunnel
Last Updated：2020-07-20
Description
Create a VPN tunnel.
Request Structure
POST /v{version}/vpn/{vpnId}/vpnconn?clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"secretKey": secretKey,
"localSubnets": localSubnets,
"remoteIp": remoteIp,
"remoteSubnets": remoteSubnets,
"description": description,
"vpnConnName": vpnConnName,
"ikeConfig": ikeConfig,
"ipsecConfig": ipsecConfig
} Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| clientToken | String | No | Query parameter | The idempotence Token is a ASCII string with a length not exceeding 64 bits. Refer to ClientToken Idempotence for details. |
| vpnId | String | Yes | URL parameter | Id of vpn |
| secretKey | String | Yes | Request Body parameters | A shared secret key contains 8-17 characters among which English, numbers and symbols must coexist, and the symbols are only limited to!. @#$%^*()_ |
| localSubnets | List<String> | Yes | Request Body parameters | Cidr list of local network |
| remoteIp | String | Yes | Request Body parameters | Public network IP of opposite terminal VPN gateway |
| remoteSubnets | List<String> | Yes | Request Body parameters | Cidr list of opposite terminal network |
| description | String | No | Request Body parameters | Description |
| vpnConnName | String | Yes | Request Body parameters | VPN tunnel name, upper and lower case letters, numbers, and -_ /. special characters. It must start with letters, with a length of 1-65. |
| ikeConfig | IkeConfig | Yes | Request Body parameters | IKE configuration |
| ipsecConfig | IpsecConfig | Yes | Request Body parameters | IPSec configuration |
Return Header
There are no other special headers except the public headers.
Return Parameter
| Parameter name | Type | Description |
|---|---|---|
| vpnConnId | String | Id of VPN tunnel |
Request Example
POST /v1/vpn/vpn-119bd69b/vpnconn?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"secretKey": "ddd22@www",
"localSubnets": ["192.168.0.0/20"],
"remoteIp": "10.107.245.188",
"remoteSubnets": ["192.168.100.0/24"],
"description": "111",
"vpnConnName": "vpncon",
"ikeConfig":
{
"ikeVersion": "v1",
"ikeMode": "main",
"ikeEncAlg": "aes",
"ikeAuthAlg": "sha1",
"ikePfs": "group2",
"ikeLifeTime":200
},
"ipsecConfig":
{
"ipsecEncAlg": "aes",
"ipsecAuthAlg": "sha1",
"ipsecPfs": "group2",
"ipsecLifetime": 28800
}
}Return Example
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"vpnConnId": "vpnconn-ku4cxya6nisq"
}