调用CreateVpnGateway接口创建VPN网关。

调试

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

请求参数

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

要执行的操作,取值:CreateVpnGateway

Bandwidth Integer 5

VPN网关的公网带宽,单位Mbps。

取值:5|10|20|50|100

RegionId String cn-hangzhou

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

VpcId String vpc-bp1ub1yt9cvakoelj****

VPN网关所属的VPC的ID。

Name String MYVPN

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

长度为2~128个英文或中文字符,必须以大小字母或中文开头,可包含数字、下划线(_)和短横线(-),不能以http://https://开头。

InstanceChargeType String 中国站示例值:PREPAY,国际站示例值:POSTPAY

VPN网关的计费方式,取值:PREPAY(包年包月)。

Period Integer 1

购买时长,取值:1~9|12|24|36

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

是否自动支付VPN网关的账单,取值:

  • true:自动支付VPN网关的账单。
  • false(默认值) :不自动支付VPN网关的账单。
EnableIpsec Boolean true

是否开启IPsec-VPN功能,取值:

  • true(默认值):开启IPsec-VPN功能。
  • false:不开启IPsec-VPN功能。
EnableSsl Boolean true

是否开启SSL-VPN功能,取值:

  • true:开启SSL-VPN功能。
  • false(默认值):不开启SSL-VPN功能。
SslConnections Integer 2

允许同时连接的最大客户端数量,取值:5|10|20

VSwitchId String vsw-bp1j5miw2bae9s2vt****

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

返回数据

名称 类型 示例值 描述
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B457

请求ID。

VpnGatewayId String vpn-bp1q8bgx4xnkm2ogj****

VPN网关的ID。

Name String myVpn

VPN网关的名称。

OrderId Long 20224940022015

订单ID,请前往阿里云控制台完成支付。

示例

请求示例

http(s)://vpc.aliyuncs.com/?Action=CreateVpnGateway
&Bandwidth=5
&RegionId=cn-hangzhou
&VpcId=vpc-bp1ub1yt9cvakoelj****
&<公共请求参数>

正常返回示例

XML 格式

<CreateVpnGatewayResponse>
      <Name>myVpn</Name>
      <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
      <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B457</RequestId>
</CreateVpnGatewayResponse>

JSON 格式

{
    "CreateVpnGatewayResponse": {
        "Name": "myVpn",
        "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
        "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457"
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 Resource.QuotaFull The quota of resource is full 资源配额已达上限。

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