创建VPN网关

最近更新时间:2018-10-26 15:00:56

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(CreateVpnGateways)用于创建VPN网关。

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateVpnGateway
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
VpcId String VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。
VpnGatewayName String VPN网关名称,最大长度不能超过60个字节。
InternetMaxBandwidthOut Integer 公网带宽设置。可选带宽规格:5, 10, 20, 50, 100;单位:Mbps
InstanceChargeType String VPN网关计费模式,PREPAID:表示预付费,即包年包月,POSTPAID_BY_HOUR:表示后付费,即按量计费。默认:POSTPAID_BY_HOUR,如果指定预付费模式,参数InstanceChargePrepaid必填。
InstanceChargePrepaid InstanceChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
Zone String 可用区,如:ap-guangzhou-2。

3. 输出参数

参数名称 类型 描述
VpnGateway VpnGateway VPN网关对象
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建按量计费网关输入

输入示例

https://vpc.tencentcloudapi.com/?Action=CreateVpnGateway
&Version=2017-03-12
&VpcId=vpc-ngenl4az
&VpnGatewayName=TEST_POSTPAID_VPNGW
&InstanceChargeType=POSTPAID_BY_HOUR
&InternetMaxBandwidthOut=5
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "1dede54a-bbad-4d7b-9110-c7cb1ed7c152",
    "VpnGateway": {
      "InstanceChargeType": "POSTPAID_BY_HOUR",
      "State": "Pending",
      "Type": "IPSEC",
      "VpcId": "vpc-ngenl4az",
      "VpnGatewayId": "vpngw-rn2yn85v",
      "VpnGatewayName": "TEST_POSTPAID_VPNGW"
    }
  }
}

示例2 创建包年包月网关输入

输入示例

https://vpc.tencentcloudapi.com/?Action=CreateVpnGateway
&Version=2017-03-12
&VpcId=vpc-5rkcp0wb
&VpnGatewayName=TEST_PREPAID_VPNGW
&InstanceChargeType=PREPAID
&InternetMaxBandwidthOut=5
&InstanceChargePrepaid.Period=1
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "7e553bb7-5603-4b79-a9f5-ecfe37d9eb27",
    "VpnGateway": {
      "InstanceChargeType": "PREPAID",
      "State": "Pending",
      "Type": "IPSEC",
      "VpcId": "vpc-5rkcp0wb",
      "VpnGatewayId": "vpngw-97yhzme3",
      "VpnGatewayName": "TEST_PREPAID_VPNGW"
    }
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InvalidParameterValue 参数值不合法。
InvalidVpcId.Malformed 无效的VPC,VPC实例ID不合法。
InvalidVpcId.NotFound 无效的VPC,VPC资源不存在。