私有网络 创建VPN网关 - API文档

1. 接口描述

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

本接口（CreateVpnGateway）用于创建VPN网关。

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

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

2. 输入参数

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

3. 输出参数

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。

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++
• Tencent Cloud SDK 3.0 for Ruby

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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