Last updated: 2020-06-24 14:18:11

    1. API Description

    Domain name for API request:

    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:

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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.
    Type No String VPN gateway type. Value: CCN, indicates CCN-type VPN gateway

    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

    Example Create Pay-As-You-Go Gateway Input

    Input Example
    &<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"

    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.


    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
    InvalidParameterValue.VpnConnCidrConflict Destination IP address range conflicts with CIDR block of the current VPC tunnel.
    InvalidVpcId.Malformed Invalid VPC. The VPC instance ID is invalid.
    InvalidVpcId.NotFound Invalid VPC. The VPC resource does not exist.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback