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.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.
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"}]. |
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. |
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>
{
"Response": {
"CustomerGateway": {
"CustomerGatewayId": "cgw-mgp33pll",
"IpAddress": "58.211.1.12",
"CustomerGatewayName": "test-cgw"
},
"RequestId": "5bd98433-263a-47b6-9a1c-84aa613a8ff6"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.TooLong | Invalid parameter value. The parameter value is too long. |
LimitExceeded | Quota limit is reached. |
VpcLimitExceeded | The maximum number of VPC resource requests for the specified region has been reached. |
Was this page helpful?