AI 助理
备案控制台
文档
输入文档关键字查找
首页 VPN网关 IPsec-VPN 开发参考 API参考 API目录 VPN网关 CreateVpnGateway - 创建VPN网关

CreateVpnGateway - 创建VPN网关

更新时间：
产品详情
我的收藏

调用CreateVpnGateway接口创建VPN网关。

接口说明

  • 在您创建 VPN 网关前，建议您先了解 VPN 网关的使用限制。更多信息，请参见 VPN 网关使用限制。

  • 部分地域的 VPN 网关实例默认仅支持创建双隧道模式 IPsec-VPN 连接，您在这些地域调用CreateVpnGateway接口创建 VPN 网关实例时，除了需要输入必填参数外，还需要输入 VSwitchId 和 DisasterRecoveryVSwitchId 参数的值。关于支持双隧道模式 IPsec-VPN 连接的地域和可用区信息，请参见IPsec-VPN 连接升级为双隧道模式。

  • CreateVpnGateway 接口属于异步接口，即系统先返回一个实例 ID，但该 VPN 网关尚未创建成功，系统后台的创建任务仍在进行。您可以调用 DescribeVpnGateway 查询 VPN 网关的创建状态：

    • 当 VPN 网关处于 provisioning 状态时，表示 VPN 网关正在创建中。
    • 当 VPN 网关处于 active 状态时，表示 VPN 网关创建成功。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:CreateVpnGatewaycreate
*VpnGateway
acs:vpc:{#regionId}:{#accountId}:vpngateway/*
    无
无

请求参数

名称类型必填描述示例值
RegionIdstring是

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

cn-hangzhou
Namestring否

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

长度为 2～100 个字符，不能以http://或https://开头，需要以大写或小写字母开头，后面可包含大小写字母、数字、下划线（_）、短划线（-）和半角句号（.），不支持其他特殊字符。

MYVPN
VpcIdstring是

VPN 网关所属的 VPC 实例 ID。

vpc-bp1ub1yt9cvakoelj****
InstanceChargeTypestring否

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

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

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

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

说明 InstanceChargeType 参数的值为 PREPAY 时，该参数必选。
1
AutoPayboolean否

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

  • true：自动支付 VPN 网关的账单。

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

说明 为了成功创建 VPN 网关实例，建议您开启自动支付。如果您关闭了自动支付，则需要手动支付账单才能成功创建 VPN 网关实例。
false
Bandwidthinteger是

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

  • 如果您要创建公网 VPN 网关，则取值为：5、10、20、50、100、200、500 或 1000。
  • 如果您要创建私网 VPN 网关，则取值为：200 或 1000。
说明 部分地域下 VPN 网关支持的最大带宽规格为 500 Mbps。更多信息，请参见 VPN 网关使用限制。
5
EnableIpsecboolean否

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

  • true（默认值）：开启 IPsec-VPN 功能。

  • false：不开启 IPsec-VPN 功能。

true
EnableSslboolean否

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

  • true：开启 SSL-VPN 功能。

  • false（默认值）：不开启 SSL-VPN 功能。

false
SslConnectionsinteger否

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

5
VSwitchIdstring否

指定 VPN 网关实例关联的交换机实例。

  • 在支持创建双隧道模式 IPsec-VPN 连接的地域，本参数必填，您必须指定一个交换机实例，同时您还要指定 DisasterRecoveryVSwitchId 参数的值。
  • 在支持创建单隧道模式 IPsec-VPN 连接的地域，如果您不指定交换机实例，系统将从 VPC 下自动选择一个交换机实例。
vsw-bp1j5miw2bae9s2vt****
VpnTypestring否

VPN 网关类型。取值：

  • Normal（默认值）：普通型。
  • NationalStandard：国密型。
Normal
ClientTokenstring否

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

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

说明 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4****
NetworkTypestring否

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

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

指定 VPN 网关实例关联的第二个交换机实例。

  • 如果当前地域支持创建双隧道模式的 IPsec-VPN 连接，则本参数必填。
  • 您需要从 VPN 网关实例关联的 VPC 实例下指定两个分布在不同可用区的交换机实例，以实现 IPsec-VPN 连接可用区级别的容灾。
  • 对于仅支持一个可用区的地域 ，不支持可用区级别的容灾，建议您在该可用区下指定两个不同的交换机实例以实现 IPsec-VPN 连接的高可用，支持指定相同的交换机实例。

关于支持双隧道模式 IPsec-VPN 连接的地域和可用区的信息，请参见IPsec-VPN 连接升级为双隧道模式。

vsw-p0wiz7obm0tbimu4r****
ResourceGroupIdstring否

VPN 网关所属的资源组 ID。

  • 您可以调用 ListResourceGroups 接口查询资源组 ID。

  • 如果您未指定资源组 ID，VPN 网关创建完成后将归属于默认资源组。

  • VPN 网关创建完成后，如果您在 VPN 网关下创建 SSL 服务端、SSL 客户端证书、IPsec 服务端或 IPsec 连接（指 IPsec 连接绑定 VPN 网关的场景），则这些资源将直接归属在 VPN 网关所属的资源组下，且不支持修改。

    如果您修改了 VPN 网关所属的资源组，则上述资源所属的资源组也将一并被修改。

rg-acfmzs372yg****

返回参数

名称类型描述示例值
object

返回结果。

VpnGatewayIdstring

VPN 网关实例 ID。

vpn-uf68lxhgr7ftbqr3p****
RequestIdstring

请求 ID。

EB2C156A-41F8-49CC-A756-D55AFC8BFD69
Namestring

VPN 网关的名称。

MYVPN
OrderIdlong

订单 ID。

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

208240895400460

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidVpcId.NotFoundThe specified VPC id does not exist in our records.-
400InvalidNameThe specified value of Name not supported.-
400InvalidSpec.NotFoundThe specified Spec does not exist in our records.-
400InvalidPeriodThe specified period is not valid-
400ChargeType.NotSupportThe specified charge type is not support.-
400InventoryNotEnoughThe inventory is not enough.-
400UnnecessarySslConnectionThe SSL connection is unnecessary for ssl vpn disabled.-
400InvalidVpnEnableEither IPsec or SSL VPN must be set enable.-
400Resource.QuotaFullThe quota of resource is full资源配额已达上限。
400InvalidVSwitchId.NotFoundThe specified vswitchId is not found.-
400OperationFailed.InventoryNotEnoughNo enough available resource. Try another vswitch with different available zone.-
400Forbidden.OperateShareResourceOperating shared resources is forbidden.-
400OperationFailed.IpNotEnoughOperation failed because private ip address of the virtual switch is not enough.-
400Forbidden.NoSLRPermissionUser not authorized to create service linked role.-
400OperationFailed.VSwitchConflictThe vswitch can't create vpn. Try another vswitch.-
400OperationFailed.AzNotSupportCurrent available zone can't create vpn. Try another vswitch with different available zone.-
400OperationFailed.NetworkTypeNotMatchCreate NationalStandard vpn with private networkType is unsupported.-
400OperationFailed.SslNotSupportEnable ssl vpn with private networkType is unsupported.私网类型VPN网关不支持开启SSL功能。
400Forbidden.TagKey.DuplicatedThe specified tag key already exists.标签资源重复
400SizeLimitExceeded.TagNumThe maximum number of tags is exceeded.标签数量超限
400InvalidParameter.TagValueThe specified parameter TagValue is invalid.指定的参数TagValue不合规范。
400InvalidParameter.TagKeyThe specified parameter TagKey is invalid.指定的参数TagKey不合规范。
400Duplicated.TagKeyThe specified parameter TagKey is duplicated.指定的参数TagKey重复。
400InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误
400InvalidVSwitchId.SecondVswitchNotSupportThe available zone of vswitch2 not supported.备vSwitch所在可用区不支持。
400Resource.QuotaFullThe resources you are operating have reached the upper limit of the quota. Please increase the quota or use other solutions to avoid it according to the VPN operation document.您现在所操作的资源目前已经达到了配额的上限，请参考VPN操作文档，进行配额提升或者使用其他方案进行规避。
400InvalidVSwitchId.FirstVswitchNotSupportThe available zone of vswitch1 not supported.主vSwitch所在可用区不支持。
400InvalidVSwitchId.VswitchIdShouldDifferentThe VSwitch ids should be different.主备可用区不能相同。
400InvalidVSwitchId.FirstVswitchIpNotEnoughThe ip of vswitch1 not enough.主vSwitch中可用IP数量不足。
400InvalidVSwitchId.SecondVswitchIpNotEnoughThe ip of vswitch2 not enough.备vSwitch中的可用IP不足。
400InvalidVSwitchId.ZoneIdShouldDifferentTwo vSwitches should belong to different Availability Zones.创建双隧道VPN时指定的两个虚拟交换机必须要属于不同可用区
404InvalidRegionId.NotFoundThe specified region is not found during access authentication.接入认证时未找到指定区域。

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

变更历史

变更时间变更内容概要操作
2024-06-18OpenAPI 错误码发生变更查看变更详情
2024-01-04OpenAPI 错误码发生变更查看变更详情
2023-10-19OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-06-30OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-05-04OpenAPI 错误码发生变更查看变更详情
上一篇：VPN网关下一篇：AssociateVpnGatewayWithCertificate - 将VPN网关与证书关联
文档推荐