文档中心 > CreateVpn
CreateVpn

最近更新时间:2021-12-29

请求方法:POST

接口描述: 使用CreateVpn接口申请VPN。


请求参数

Param

名称

类型

是否必选

描述

Action

String

要执行的操作,取值:CreateVpn。

RegionId

String

地域ID。 HB1-BJMY (华北2-北京2) ; HD1-SHMY(华东1-上海)

Body

名称

类型

是否必选

描述

ChargeType

String

付费类型。prepaid:预付费; postpaid:后付费

AzoneId

String

可用区ID。

OrderCategory

String

订单类型,NEW:新购。

ComponentProperty

Object

规格信息。

+Bandwidth

Integer

带宽。

+ConnectionCount

Integer

最大链接数。

+InstanceBandwidthCode

Integer

带宽线路vpn.bgp.static。

+InstanceTypeCode

Integer

实例类型vpn.ipsec.normal。

+SubnetId

String

子网ID。

+VpcId

String

VPC ID。

+PrivateAddress

String

指定地址。

InstanceCode

String

规格编码,vpn.ipsec.normal。

InstanceName

String

实例名称。

PayType

String

计费类型 YEAR_MONTH:包年包月。

ProductDescription

String

配置描述。

Quantity

Integer

数量。

RenewType

string

续费方式,包年包月必传,值为:manualrenew ;后付费值为:notrenew

RentCount

String

包年包月时长,取值为:1,2,3,6,12,24,36

RentUnit

String

时长单位,包年包月必传,month


返回参数

名称

类型

描述

RequestId

String

请求ID。

Code

String

创建结果编码。

Msg

String

创建结果描述。

Res

Object

响应结果。

+Resources

Array

新建的实例列表。

++InstanceId

String

分配的NAT的ID。

++Product

String

产品名称。

+OrderId

String

订单ID。


示例

请求示例

POST https://openapi.unicloud.com/networks/vpn?Action=CreateVpn
&RegionId=HB1-BJMY
&公共请求参数

body
{
 "ProductProperties": [],
 "RentUnit": "month",
 "InstanceCode": "vpn.ipsec.normal",
 "Quantity": 1,
 "PayType": "CHARGING_HOURS",
 "CommonProperties": {
   "InstanceTypeCode": "vpn.ipsec.normal",
   "Description": "",
   "ConnectionCount": 10,
   "VpcId": "vpc-c4gp6upgmqcpb",
   "Bandwidth": 10,
   "InstanceBandwidthCode": "vpn.bgp.static",
   "SubnetId": "cfdae3e29f034996b04ec2e886af9bca",
   "PrivateAddress": ""
},
 "RentCount": 1,
 "InstanceName": "dddd",
 "ComponentProperty": {},
 "ChargeType": "postpaid",
 "RenewType": "manualrenew",
 "AzoneId": "cn-beijing-a",
 "ProductDescription": "{\"name\":\"dddd\",\"conf\":{\"实例名称\":\"dddd\",\"地域\":\"华北2-北京2\",\"计费模式\":\"按小时实时付费\",\"类型\":\"IPsec\",\"IPSec接入数\":10,\"带宽\":\"10Mbps\"}}",
 "OrderCategory": "NEW"
}

返回示例

JSON 格式

{
 "Msg": "下单成功",
 "Res": {
   "Resources": [
    {
       "InstanceId": "vpn-kftzbjs1llgj",
       "Product": "VPN"
    }
  ],
   "OrderId": "1336498096636846160"
},
 "Code": "Network.Success"
}