调用CreateVpnGateway接口创建VPN网关。

使用说明

  • 在您创建VPN网关前，建议您先了解VPN网关的使用限制。更多信息，请参见VPN网关使用限制。
  • CreateVpnGateway接口属于异步接口，即系统先返回一个实例ID，但该VPN网关尚未创建成功，系统后台的创建任务仍在进行。您可以调用 DescribeVpnGateway查询VPN网关的创建状态：
    • 当VPN网关处于provisioning状态时，表示VPN网关正在创建中。
    • 当VPN网关处于active状态时，表示VPN网关创建成功。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateVpnGateway

系统规定参数。取值：CreateVpnGateway。

RegionId String 是 cn-hangzhou

VPN网关所在的地域。您可以通过调用DescribeRegions接口获取地域ID。

Name String 否 MYVPN

VPN网关的名称，默认值为VPN网关的ID。

长度为1～100个字符，不能以http://或https://开头。

VpcId String 是 vpc-bp1ub1yt9cvakoelj****

VPN网关所属的VPC实例ID。

InstanceChargeType String 否 中国站示例值：PREPAY，国际站示例值：POSTPAY

VPN网关的计费方式。仅取值：PREPAY，包年包月。

在您创建VPN网关时，该参数为必填项。
Period Integer 否 1

购买时长。单位：月。取值：1~9、12、24或36。

说明 InstanceChargeType参数的值为PREPAY时，该参数必选。
AutoPay Boolean 否 false

是否自动支付VPN网关的账单。取值：

  • true：自动支付VPN网关的账单。
  • false（默认值）：不自动支付VPN网关的账单。
Bandwidth Integer 是 5

VPN网关的带宽规格。单位：Mbps。

  • 如果您要创建公网VPN网关，则取值为：5、10、20、50、100、200、500或1000。

  • 如果您要创建私网VPN网关，则取值为：200或1000。

说明 部分地域下VPN网关支持的最大带宽规格为200 Mbps。更多信息，请参见VPN网关使用限制。
EnableIpsec Boolean 否 true

是否开启IPsec-VPN功能。取值：

  • true（默认值）：开启IPsec-VPN功能。
  • false：不开启IPsec-VPN功能。
EnableSsl Boolean 否 false

是否开启SSL-VPN功能。取值：

  • true：开启SSL-VPN功能。
  • false（默认值）：不开启SSL-VPN功能。
SslConnections Integer 否 5

允许同时连接的最大客户端数量。取值：5（默认值）、10、20、50、100、200、500、1000。

VSwitchId String 否 vsw-bp1j5miw2bae9s2vt****

VPN网关所属的交换机的实例ID。

VpnType String 否 Normal

VPN网关类型。取值：

  • Normal（默认值）：普通型。

  • NationalStandard：国密型。
ClientToken String 否 02fb3da4****

客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
NetworkType String 否 public

VPN网关的网络类型。取值：

  • public（默认值）：公网VPN网关。
  • private：私网VPN网关。

返回数据

名称 类型 示例值 描述
VpnGatewayId String vpn-uf68lxhgr7ftbqr3p****

VPN网关实例ID。
RequestId String EB2C156A-41F8-49CC-A756-D55AFC8BFD69

请求ID。
Name String MYVPN

VPN网关的名称。
OrderId Long 208240895400460

订单ID。

如果您未选择自动支付VPN网关的账单，请前往阿里云用户中心完成支付。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateVpnGateway
&RegionId=cn-hangzhou
&Name=MYVPN
&VpcId=vpc-bp1ub1yt9cvakoelj****
&InstanceChargeType=PREPAY
&Period=1
&AutoPay=false
&Bandwidth=5
&EnableIpsec=true
&EnableSsl=true
&SslConnections=5
&VSwitchId=vsw-bp1j5miw2bae9s2vt****
&VpnType=Normal
&ClientToken=02fb3da4****
&NetworkType=public
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateVpnGatewayResponse>
    <VpnGatewayId>vpn-uf68lxhgr7ftbqr3p****</VpnGatewayId>
    <RequestId>EB2C156A-41F8-49CC-A756-D55AFC8BFD69</RequestId>
    <Name>MYVPN</Name>
    <OrderId>208240895400460</OrderId>
</CreateVpnGatewayResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "VpnGatewayId" : "vpn-uf68lxhgr7ftbqr3p****",
  "RequestId" : "EB2C156A-41F8-49CC-A756-D55AFC8BFD69",
  "Name" : "MYVPN",
  "OrderId" : 208240895400460
}

错误码

HttpCode 错误码 错误信息 描述
400 Resource.QuotaFull The quota of resource is full 资源配额已达上限。
404 InvalidRegionId.NotFound The specified region is not found during access authentication. 接入认证时未找到指定区域。

访问错误中心查看更多错误码。