tencent cloud

All product documents
APIs
DocumentationAPIsVirtual Private CloudVPN Gateway APIsCreateCustomerGateway
CreateCustomerGateway
Last updated: 2024-11-25 20:03:02
CreateCustomerGateway
Last updated: 2024-11-25 20:03:02

1. API Description

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

This API (CreateCustomerGateway) is used to create customer gateways.

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: CreateCustomerGateway.
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.
CustomerGatewayName Yes String Customer gateway can be named freely, but the maximum length is 60 characters.
IpAddress Yes String Customer gateway public IP.
Tags.N No Array of Tag Bound tags, such as [{"Key": "city", "Value": "shanghai"}].

3. Output Parameters

Parameter Name Type Description
CustomerGateway CustomerGateway Customer 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 customer gateway

This example shows you how to create a customer gateway.

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCustomerGateway
<Common request parameters>

{
    "IpAddress": "58.211.1.12",
    "CustomerGatewayName": "test-cgw",
    "Tags": [
        {
            "Value": "shanghai",
            "Key": "city"
        }
    ]
}

Output Example

{
    "Response": {
        "CustomerGateway": {
            "CustomerGatewayId": "cgw-mgp33pll",
            "IpAddress": "58.211.1.12",
            "CustomerGatewayName": "test-cgw",
            "CreatedTime": "2018-04-18 10:00:00"
        },
        "RequestId": "5bd98433-263a-47b6-9a1c-84aa613a8ff6"
    }
}

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.Duplicate The input parameter already exists.
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.
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.
UnsupportedOperation.RecordExists This record already exists.
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.VpnUnsupportedBgp
VpcLimitExceeded The maximum number of VPC resource requests for the specified region has been reached.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon