调用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:CreateVpnGateway | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | VPN网关所在的地域。您可以通过调用DescribeRegions接口获取地域ID。 | cn-hangzhou |
Name | string | 否 | VPN网关的名称,默认值为VPN网关的ID。 长度为2~100个字符,不能以 | MYVPN |
VpcId | string | 是 | VPN网关所属的VPC实例ID。 | vpc-bp1ub1yt9cvakoelj**** |
InstanceChargeType | string | 否 | VPN网关的计费方式。仅取值:POSTPAY,按量计费。 | 中国站示例值:PREPAY,国际站示例值:POSTPAY |
Period | integer | 否 | 购买时长。单位:月。取值:1~9、12、24或36。 | 1 |
AutoPay | boolean | 否 | 是否自动支付VPN网关的账单。取值:
说明
为了成功创建VPN网关实例,建议您开启自动支付。如果您关闭了自动支付,则需要手动支付账单才能成功创建VPN网关实例。
| false |
Bandwidth | integer | 是 | VPN网关的带宽规格。单位:Mbps。
说明
部分地域下VPN网关支持的最大带宽规格为200 Mbps。更多信息,请参见VPN网关使用限制。
| 5 |
EnableIpsec | boolean | 否 | 是否开启IPsec-VPN功能。取值:
| true |
EnableSsl | boolean | 否 | 是否开启SSL-VPN功能。取值:
| false |
SslConnections | integer | 否 | 允许同时连接的最大客户端数量。取值:5(默认值)、10、20、50、100、200、500、1000。 | 5 |
VSwitchId | string | 否 | 指定VPN网关实例关联的交换机实例。
| vsw-bp1j5miw2bae9s2vt**** |
VpnType | string | 否 | VPN网关类型。取值:
| Normal |
ClientToken | string | 否 | 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明
若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
| 02fb3da4**** |
NetworkType | string | 否 | VPN网关的网络类型。取值:
| public |
DisasterRecoveryVSwitchId | string | 否 | 指定VPN网关实例关联的第二个交换机实例。
关于支持双隧道模式IPsec-VPN连接的地域和可用区的信息,请参见IPsec-VPN连接升级为双隧道模式。 | vsw-p0wiz7obm0tbimu4r**** |
ResourceGroupId | string | 否 | VPN网关所属的资源组ID。
| rg-acfmzs372yg**** |
返回参数
示例
正常返回示例
JSON
格式
{
"VpnGatewayId": "vpn-uf68lxhgr7ftbqr3p****",
"RequestId": "EB2C156A-41F8-49CC-A756-D55AFC8BFD69",
"Name": "MYVPN",
"OrderId": 208240895400460
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidVpcId.NotFound | The specified VPC id does not exist in our records. | - |
400 | InvalidName | The specified value of Name not supported. | - |
400 | InvalidSpec.NotFound | The specified Spec does not exist in our records. | - |
400 | InvalidPeriod | The specified period is not valid | - |
400 | ChargeType.NotSupport | The specified charge type is not support. | - |
400 | InventoryNotEnough | The inventory is not enough. | - |
400 | UnnecessarySslConnection | The SSL connection is unnecessary for ssl vpn disabled. | - |
400 | InvalidVpnEnable | Either IPsec or SSL VPN must be set enable. | - |
400 | Resource.QuotaFull | The quota of resource is full | 资源配额已达上限。 |
400 | InvalidVSwitchId.NotFound | The specified vswitchId is not found. | - |
400 | OperationFailed.InventoryNotEnough | No enough available resource. Try another vswitch with different available zone. | - |
400 | Forbidden.OperateShareResource | Operating shared resources is forbidden. | - |
400 | OperationFailed.IpNotEnough | Operation failed because private ip address of the virtual switch is not enough. | - |
400 | Forbidden.NoSLRPermission | User not authorized to create service linked role. | - |
400 | OperationFailed.VSwitchConflict | The vswitch can't create vpn. Try another vswitch. | - |
400 | OperationFailed.AzNotSupport | Current available zone can't create vpn. Try another vswitch with different available zone. | - |
400 | OperationFailed.NetworkTypeNotMatch | Create NationalStandard vpn with private networkType is unsupported. | - |
400 | OperationFailed.SslNotSupport | Enable ssl vpn with private networkType is unsupported. | 私网类型VPN网关不支持开启SSL功能。 |
400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | 标签资源重复 |
400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | 标签数量超限 |
400 | InvalidParameter.TagValue | The specified parameter TagValue is invalid. | 指定的参数TagValue不合规范。 |
400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | 指定的参数TagKey不合规范。 |
400 | Duplicated.TagKey | The specified parameter TagKey is duplicated. | 指定的参数TagKey重复。 |
400 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误 |
404 | InvalidRegionId.NotFound | The specified region is not found during access authentication. | 接入认证时未找到指定区域。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-10-19 | OpenAPI 描述信息更新,OpenAPI 去除了 deprecated 标记,OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-06-30 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-05-04 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
|