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.
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"}]. |
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. |
This example shows you how to create a customer gateway.
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"
}
]
}
{
"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"
}
}
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.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?