私有网络创建VPN网关-API 文档-文档中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateVpnGateway。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
VpcId	是	String	VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。示例值：vpc-ngenl4az
VpnGatewayName	是	String	VPN网关名称，最大长度不能超过60个字节。示例值：TEST_POSTPAID_VPNGW
InternetMaxBandwidthOut	是	Integer	公网带宽设置。可选带宽规格：5, 10, 20, 50, 100, 200, 500, 1000, 3000；单位：Mbps。示例值：5
InstanceChargeType	否	String	VPN网关计费模式，PREPAID：表示预付费，即包年包月，POSTPAID_BY_HOUR：表示后付费，即按量计费。默认：POSTPAID_BY_HOUR，如果指定预付费模式，参数InstanceChargePrepaid必填。示例值：POSTPAID_BY_HOUR
InstanceChargePrepaid	否	InstanceChargePrepaid	预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
Zone	否	String	可用区，如：ap-guangzhou-2。示例值：ap-guangzhou
Type	否	String	VPN网关类型，默认为IPSEC。值“IPSEC”为VPC型IPSEC VPN网关，值“SSL”为VPC型SSL VPN网关，值“CCN”为云联网型IPSEC VPN网关，值“SSL_CCN”为云联网型SSL VPN网关。示例值：CCN
Tags.N	否	Array of Tag	指定绑定的标签列表，例如：[{"Key": "city", "Value": "shanghai"}]。
CdcId	否	String	CDC实例ID。示例值：cluster-gbo27yc4
MaxConnection	否	Integer	SSL VPN连接数设置，可选规格：5, 10, 20, 50, 100, 200, 500, 1000；单位：个。仅 SSL / SSL_CCN 类型需要选这个参数。示例值：5

3. 输出参数

参数名称	类型	描述
VpnGateway	VpnGateway	VPN网关对象
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建VPNGW

创建VPNGW

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVpnGateway
<公共请求参数>

{
    "VpnGatewayName": "\"test\"",
    "VpcId": "\"vpc-xxxx\"",
    "InstanceChargeType": "\"POSTPAID_BY_HOUR\"",
    "InternetMaxBandwidthOut": 5
}

输出示例

{
    "Response": {
        "VpnGateway": {
            "VpnGatewayQuotaSet": [],
            "MaxConnection": 5,
            "VpcId": "vpc-test",
            "RenewFlag": "",
            "Zone": "ap-bangkok-1",
            "VpnGatewayName": "test",
            "InstanceChargeType": "POSTPAID_BY_HOUR",
            "CdcId": "",
            "IsAddressBlocked": true,
            "InternetMaxBandwidthOut": 10,
            "State": "Pending",
            "Version": "",
            "VpnGatewayId": "vpngw-xxxxx",
            "PublicIpAddress": "12.3.1.3",
            "CreatedTime": "2020-09-22 00:00:00",
            "NewPurchasePlan": "",
            "ExpiredTime": "2020-09-22 00:00:00",
            "Type": "IPSEC",
            "NetworkInstanceId": "",
            "RestrictState": "NORMAL"
        },
        "RequestId": "fa15cd12-e329-1261-c585-3c3ae5c55211"
    }
}

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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameterValue	参数取值错误。
InvalidParameterValue.Duplicate	入参重复。
InvalidParameterValue.Empty	缺少参数。
InvalidParameterValue.Malformed	入参格式不合法。
InvalidParameterValue.TagDuplicateKey	标签键重复。
InvalidParameterValue.TagDuplicateResourceType	重复的标签资源类型。
InvalidParameterValue.TagInvalidKey	标签键无效。
InvalidParameterValue.TagInvalidKeyLen	标签键长度无效。
InvalidParameterValue.TagInvalidVal	标签值无效。
InvalidParameterValue.TagKeyNotExists	标签键不存在。
InvalidParameterValue.TagNotAllocatedQuota	标签没有分配配额。
InvalidParameterValue.TagNotExisted	该标签不存在。
InvalidParameterValue.TagNotSupportTag	不支持的标签。
InvalidParameterValue.TagResourceFormatError	标签资源格式错误。
InvalidParameterValue.TagTimestampExceeded	标签时间戳超配。
InvalidParameterValue.TagValNotExists	标签值不存在。
InvalidParameterValue.TooLong	无效参数值。参数值太长。
InvalidParameterValue.VpnConnCidrConflict	目的网段和当前VPN通道的CIDR冲突。
InvalidVpcId.Malformed	无效的VPC,VPC实例ID不合法。
InvalidVpcId.NotFound	无效的VPC,VPC资源不存在。
LimitExceeded	超过配额限制。
LimitExceeded.TagKeyExceeded	标签键已达到上限。
LimitExceeded.TagKeyPerResourceExceeded	每个资源的标签键已达到上限。
LimitExceeded.TagNotEnoughQuota	没有足够的标签配额。
LimitExceeded.TagQuota	标签配额已满，无法创建资源。
LimitExceeded.TagQuotaExceeded	标签配额已达到上限。
LimitExceeded.TagTagsExceeded	标签键的数目已达到上限。
ResourceNotFound	资源不存在。
UnauthorizedOperation.NoRealNameAuthentication	账号未实名。
UnsupportedOperation	操作不支持。
UnsupportedOperation.InsufficientFunds	账户余额不足。
UnsupportedOperation.TagAllocate	标签正在分配中。
UnsupportedOperation.TagFree	标签正在释放中。
UnsupportedOperation.TagNotPermit	标签没有权限。
UnsupportedOperation.TagSystemReservedTagKey	不支持使用系统预留的标签键。
UnsupportedOperation.VpnGwVpcIdMustHave	VPC类型VPN网关必须携带VpcId。
UnsupportedOperation.VpnUnsupportedBgp	VPN不支持BGP

创建VPN网关

本页目录：