CreateCustomerGateway

Last updated: 2021-03-19 16:26:03

1. API Description

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

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

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

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: CreateCustomerGateway.
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.
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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a customer gateway

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateCustomerGateway
&Version=2017-03-12
&CustomerGatewayName=test-cgw
&IpAddress=58.211.1.12
&Tags.0.Key=city
&Tags.0.Value=shanghai
&<Common request parameters>

Output Example

{
  "Response": {
    "CustomerGateway": {
      "CustomerGatewayId": "cgw-mgp33pll",
      "IpAddress": "58.211.1.12",
      "CustomerGatewayName": "test-cgw"
    },
    "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

Tencent Cloud CLI 3.0

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.
LimitExceeded	Quota limit is reached.
VpcLimitExceeded	The maximum number of VPC resource requests for the specified region has been reached.

Recent Pages