CreateVpnGateway

Last updated: 2020-03-06 20:26:15

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API (CreateVpnGateway) is used to create a VPN gateway.

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateVpnGateway.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
VpcId Yes String The ID of the VPC instance. You can obtain the parameter value from the VpcId field in the returned result of DescribeVpcs API.
VpnGatewayName Yes String The VPN gateway name. The maximum length is 60 bytes.
InternetMaxBandwidthOut Yes Integer The public network bandwidth configuration. Available bandwidth specifications: 5, 10, 20, 50, and 100. Unit: Mbps
InstanceChargeType No String The VPN gateway billing mode. PREPAID: prepaid means monthly subscription. POSTPAID_BY_HOUR: postpaid means pay-as-you-go. Default: POSTPAID_BY_HOUR. If prepaid mode is specified, the InstanceChargePrepaid parameter must be entered.
InstanceChargePrepaid No InstanceChargePrepaid Parameter settings for prepaid billing mode, also known as monthly subscription. This parameter can specify the purchase period and other attributes such as auto-renewal. This parameter is mandatory for prepaid instances.
Zone No String The availability zone, such as ap-guangzhou-2.

3. Output Parameters

Parameter Name Type Description
VpnGateway VpnGateway VPN gateway object.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a pay-as-you-go gateway

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateVpnGateway
&Version=2017-03-12
&VpcId=vpc-ngenl4az
&VpnGatewayName=TEST_POSTPAID_VPNGW
&InstanceChargeType=POSTPAID_BY_HOUR
&InternetMaxBandwidthOut=5
&<Common Request Parameters>

Output Example

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

Example2 Creating a monthly subscription gateway

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateVpnGateway
&Version=2017-03-12
&VpcId=vpc-5rkcp0wb
&VpnGatewayName=TEST_PREPAID_VPNGW
&InstanceChargeType=PREPAID
&InternetMaxBandwidthOut=5
&InstanceChargePrepaid.Period=1
&<Common Request Parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameterValue Invalid parameter value
InvalidVpcId.Malformed Invalid VPC. The VPC instance ID is invalid.
InvalidVpcId.NotFound Invalid VPC. The VPC resource does not exist.