Help & DocumentationVirtual Private CloudAPI DocumentationVPN Gateway-Related APIsCreateVpnGateway

CreateVpnGateway

Last updated: 2019-11-29 18:04:55

PDF

Contents：

1. API Description

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

This API (CreateVpnGateways) is used to create VPN gateways.

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

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, 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 VPC instance ID. You can obtain the parameter value from the VpcId field value in the returned result of API DescribeVpcs.
VpnGatewayName Yes String VPN gateway name, which is limited to 60 bytes.
InternetMaxBandwidthOut Yes Integer Public network bandwidth setting. Available bandwidth specifications: 5, 10, 20, 50, and 100 (in Mbps)
InstanceChargeType No String Billing method of the VPN gateway. PREPAID: Prepaid; POSTPAID_BY_HOUR: Postpaid. Default is POSTPAID_BY_HOUR. If the prepaid mode is specified, the parameter InstanceChargePrepaid is required.
InstanceChargePrepaid No InstanceChargePrepaid Indicates the relevant parameter setting for the prepaid mode. This parameter can specify the purchased usage period, whether to set automatic renewal, and other attributes of the instance purchased on a prepaid basis. This parameter is required if the billing method for the specified instance is prepaid.

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. Error Codes

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.

5. Example

Example 1 Create a postpaid 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": {
    "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"
    }
  }
}

Example 2 Create a prepaid 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": {
    "RequestId": "7e553bb7-5603-4b79-a9f5-ecfe37d9eb27",
    "VpnGateway": {
      "InstanceChargeType": "PREPAID",
      "State": "Pending",
      "Type": "IPSEC",
      "VpcId": "vpc-5rkcp0wb",
      "VpnGatewayId": "vpngw-97yhzme3",
      "VpnGatewayName": "TEST_PREPAID_VPNGW"
    }
  }
}

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.