Create VPN
Last Updated：2020-07-20
Description
Create VPN.
Request Structure
POST /v{version}/vpn?clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"vpcId": vpcId,
"vpnName": vpnName,
"description": description,
"eip": eip,
"billing": {
"paymentTiming": paymentTiming,
"reservation": {
"reservationLength": reservationLength,
"reservationTimeUnit": reservationTimeUnit
}
}
} 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. |
| vpcId | String | Yes | Request Body parameters | Id of vpc affiliated |
| vpnName | String | Yes | Request Body parameters | VPN name, upper and lower case letters, numbers, and -_ /. special characters. It must start with letters, with a length of 1-65. |
| description | String | No | Request Body parameters | VPN description |
| eip | String | No | Request Body parameters | Eip bound to vpn |
| billing | Billing | Yes | Request Body parameters | The charging information supports the prepayment and post-payment modes. |
Return Header
There are no other special headers except the public headers.
Return Parameter
| Parameter name | Type | Description |
|---|---|---|
| vpnId | String | id of VPN |
Request Example
Prepaid
POST /v1/vpn?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
{
"vpcId": "vpc-IyWRtII7",
"vpnName": "vpnName",
"description": "description",
"eip": "",
"billing":{
"reservation":{
"reservationLength":1,
"reservationTimeUnit":"month"
},
"paymentTiming":"Prepaid"
}
} Postpaid
POST /v1/vpn?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
{
"vpcId": "vpc-IyWRtII7",
"vpnName": "vpnName",
"description": "description",
"eip": "",
"billing":{
"paymentTiming":"Postpaid"
}
} 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
{
"vpnId": "vpn-ku4cxya6nisq"
}