操作指南

API文档

创建VPN网关

最近更新时间:2021-05-25 08:10:52

我的收藏

1. 接口描述

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

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

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。
Type String VPN网关类型。值“CCN”云联网类型VPN网关
Tags.N Array of Tag 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]

3. 输出参数

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

4. 示例

示例1 创建按量计费网关

输入示例

https://vpc.tencentcloudapi.com/?Action=CreateVpnGateway
&VpcId=vpc-ngenl4az
&VpnGatewayName=TEST_POSTPAID_VPNGW
&InstanceChargeType=POSTPAID_BY_HOUR
&InternetMaxBandwidthOut=5
&Tags.0.Key=city
&Tags.0.Value=shanghai
&<公共请求参数>

输出示例

{
  "Response": {
    "VpnGateway": {
      "VpcId": "vpc-ngenl4az",
      "VpnGatewayId": "vpngw-test1234",
      "VpnGatewayName": "TEST_POSTPAID_VPNGW",
      "Type": "IPSEC",
      "State": "AVAILABLE",
      "PublicIpAddress": "xxx.xxx.xxx.xxx",
      "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
      "InstanceChargeType": "POSTPAID_BY_HOUR",
      "InternetMaxBandwidthOut": 5,
      "CreatedTime": "2020-10-13 19:03:26",
      "ExpiredTime": "2020-12-13 19:04:54",
      "IsAddressBlocked": false,
      "NewPurchasePlan": "",
      "RestrictState": "NORMAL",
      "Zone": "ap-shanghai-1",
      "Version": "ver2.0",
      "NetworkInstanceId": "vpc-i9otxqn5",
      "VpnGatewayQuotaSet": [
        {
          "Bandwidth": 5,
          "Cname": "微小型",
          "Name": "qcmini"
        },
        {
          "Bandwidth": 50,
          "Cname": "大型",
          "Name": "qclarge"
        },
        {
          "Bandwidth": 200,
          "Cname": "超大型2",
          "Name": "qcsuperLarge2"
        },
        {
          "Bandwidth": 100,
          "Cname": "超大型",
          "Name": "qcsuperLarge"
        },
        {
          "Bandwidth": 500,
          "Cname": "超大型3",
          "Name": "qcsuperLarge3"
        },
        {
          "Bandwidth": 10,
          "Cname": "小型",
          "Name": "qcsmall"
        },
        {
          "Bandwidth": 20,
          "Cname": "中型",
          "Name": "qcmiddle"
        },
        {
          "Bandwidth": 1000,
          "Cname": "超大型4",
          "Name": "qcsuperLarge4"
        }
      ]
    },
    "RequestId": "ea4bc0de-5093-423e-96ae-08f0fd4889be"
  }
}

示例2 创建包年包月网关

输入示例

https://vpc.tencentcloudapi.com/?Action=CreateVpnGateway
&VpcId=vpc-5rkcp0wb
&VpnGatewayName=TEST_PREPAID_VPNGW
&InstanceChargeType=PREPAID
&InternetMaxBandwidthOut=5
&InstanceChargePrepaid.Period=1
&Tags.0.Key=city
&Tags.0.Value=shanghai
&<公共请求参数>

输出示例

{
  "Response": {
    "VpnGateway": {
      "VpcId": "vpc-5rkcp0wb",
      "VpnGatewayId": "vpngw-test1234",
      "VpnGatewayName": "TEST_PREPAID_VPNGW",
      "Type": "IPSEC",
      "State": "AVAILABLE",
      "PublicIpAddress": "xxx.xxx.xxx.xxx",
      "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
      "InstanceChargeType": "PREPAID",
      "InternetMaxBandwidthOut": 5,
      "CreatedTime": "2020-10-13 19:03:26",
      "ExpiredTime": "2020-12-13 19:04:54",
      "IsAddressBlocked": false,
      "NewPurchasePlan": "",
      "RestrictState": "NORMAL",
      "Zone": "ap-shanghai-1",
      "Version": "ver2.0",
      "NetworkInstanceId": "vpc-i9otxqn5",
      "VpnGatewayQuotaSet": [
        {
          "Bandwidth": 5,
          "Cname": "微小型",
          "Name": "qcmini"
        },
        {
          "Bandwidth": 50,
          "Cname": "大型",
          "Name": "qclarge"
        },
        {
          "Bandwidth": 200,
          "Cname": "超大型2",
          "Name": "qcsuperLarge2"
        },
        {
          "Bandwidth": 100,
          "Cname": "超大型",
          "Name": "qcsuperLarge"
        },
        {
          "Bandwidth": 500,
          "Cname": "超大型3",
          "Name": "qcsuperLarge3"
        },
        {
          "Bandwidth": 10,
          "Cname": "小型",
          "Name": "qcsmall"
        },
        {
          "Bandwidth": 20,
          "Cname": "中型",
          "Name": "qcmiddle"
        },
        {
          "Bandwidth": 1000,
          "Cname": "超大型4",
          "Name": "qcsuperLarge4"
        }
      ]
    },
    "RequestId": "ea4bc0de-5093-423e-96ae-08f0fd4889be"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
InvalidParameterValue.VpnConnCidrConflict 目的网段和当前VPN通道的CIDR冲突。
InvalidVpcId.Malformed 无效的VPC,VPC实例ID不合法。
InvalidVpcId.NotFound 无效的VPC,VPC资源不存在。
LimitExceeded 超过配额限制。
ResourceNotFound 资源不存在。
UnauthorizedOperation.NoRealNameAuthentication 账号未实名。
UnsupportedOperation.InsufficientFunds 账户余额不足。
目录