tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateVpnGateway

Last updated: 2024-11-25 20:03:00

    1. API Description

    Domain name for API request: vpc.intl.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.

    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 Params. The value used for this API: CreateVpnGateway.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    VpcId Yes String VPC instance ID, which can be obtained from the VpcId field in the response of the 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. Values: CCN (CCN VPN gateway), SSL (SSL VPN gateway)
    Tags.N No Array of Tag Bound tags, such as [{"Key": "city", "Value": "shanghai"}].
    CdcId No String CDC instance ID
    MaxConnection No Integer Maximum number of connected clients allowed for the SSL VPN gateway. Valid values: [5, 10, 20, 50, 100]. This parameter is only required for SSL VPN gateways.

    3. Output Parameters

    Parameter Name Type Description
    VpnGateway VpnGateway VPN gateway object.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Creating a VPN gateway

    Input Example

    https://vpc.intl.tencentcloudapi.com/?Action=CreateVpnGateway
&VpcId="vpc-xxxx"
&VpnGatewayName="test"
&InstanceChargeType="POSTPAID_BY_HOUR"
&InternetMaxBandwidthOut=5
&<Common request parameters>

    Output Example

    {
    "Response": {
        "VpnGateway": {
            "VpnGatewayQuotaSet": [
                {
                    "Bandwidth": 1,
                    "Cname": "xx",
                    "Name": "xx"
                }
            ],
            "MaxConnection": 1,
            "VpcId": "xx",
            "RenewFlag": "xx",
            "Zone": "xx",
            "VpnGatewayName": "xx",
            "InstanceChargeType": "xx",
            "CdcId": "xx",
            "IsAddressBlocked": true,
            "InternetMaxBandwidthOut": 1,
            "State": "xx",
            "Version": "xx",
            "VpnGatewayId": "xx",
            "PublicIpAddress": "xx",
            "CreatedTime": "2020-09-22 00:00:00",
            "NewPurchasePlan": "xx",
            "ExpiredTime": "2020-09-22 00:00:00",
            "Type": "xx",
            "NetworkInstanceId": "xx",
            "RestrictState": "xx"
        },
        "RequestId": "xx"
    }
}

    5. Developer Resources

    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 The parameter value is invalid.
    InvalidParameterValue.Duplicate The input parameter already exists.
    InvalidParameterValue.Empty Missing parameters.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.TagDuplicateKey Duplicate tag keys.
    InvalidParameterValue.TagDuplicateResourceType Duplicate tag resource type.
    InvalidParameterValue.TagInvalidKey Invalid tag key.
    InvalidParameterValue.TagInvalidKeyLen Invalid tag key length.
    InvalidParameterValue.TagInvalidVal Invalid tag key.
    InvalidParameterValue.TagKeyNotExists The tag key does not exist.
    InvalidParameterValue.TagNotAllocatedQuota Tags are not assigned quotas.
    InvalidParameterValue.TagNotExisted The tag and value do not exist.
    InvalidParameterValue.TagNotSupportTag Unsupported tag.
    InvalidParameterValue.TagResourceFormatError 'The tag resource format error.
    InvalidParameterValue.TagTimestampExceeded Exceeded the quota of tag timestamp.
    InvalidParameterValue.TagValNotExists The tag value does not exist.
    InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
    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.
    LimitExceeded Quota limit is reached.
    LimitExceeded.TagKeyExceeded Reached the upper limit of tag keys.
    LimitExceeded.TagKeyPerResourceExceeded Reached the upper limit of tags keys per resource.
    LimitExceeded.TagNotEnoughQuota Insufficient tag quota.
    LimitExceeded.TagQuota Exceeded the tag quota. Unable to create resources.
    LimitExceeded.TagQuotaExceeded Reached the upper limit of tag quota.
    LimitExceeded.TagTagsExceeded Reached the number limit of tag keys.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation.NoRealNameAuthentication Identity verification has not been completed for the account.
    UnsupportedOperation Unsupported operation.
    UnsupportedOperation.InsufficientFunds Insufficient account balance.
    UnsupportedOperation.TagAllocate Tags are being assigned.
    UnsupportedOperation.TagFree Tags are being released.
    UnsupportedOperation.TagNotPermit Unauthorized for this tag.
    UnsupportedOperation.TagSystemReservedTagKey The specified tag key is reserved for system usage.
    UnsupportedOperation.VpnGwVpcIdMustHave
    UnsupportedOperation.VpnUnsupportedBgp
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy