Domain name for API request: vpc.tencentcloudapi.com.
This API (CreateNatGateway) is used to create a NAT gateway.
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
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: CreateNatGateway. |
| 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. |
| NatGatewayName | Yes | String | NAT gateway name |
| VpcId | Yes | String | The ID of the VPC instance. You can obtain the parameter value from the VpcId field in the returned result of DescribeVpcs API. |
| InternetMaxBandwidthOut | No | Integer | The maximum outbound bandwidth of the NAT gateway (unit: Mbps). Supported parameter values: 20, 50, 100, 200, 500, 1000, 2000, 5000. Default: 100Mbps. |
| MaxConcurrentConnection | No | Integer | The concurrent connection cap of the NAT gateway. Supported parameter values: 1000000, 3000000, 10000000. The default value is 100000. |
| AddressCount | No | Integer | The number of EIPs that needs to be applied for. The system will create N number of EIPs according to your requirements. Either AddressCount or PublicAddresses must be passed in. |
| PublicIpAddresses.N | No | Array of String | The EIP array bound to the NAT gateway. Either AddressCount or PublicAddresses must be passed in. |
| Zone | No | String | The availability zone, such as ap-guangzhou-1. |
| Tags.N | No | Array of Tag | Bound tags, such as [{"Key": "city", "Value": "shanghai"}]. |
| SubnetId | No | String | Subnet of the NAT gateway |
| Parameter Name | Type | Description |
|---|---|---|
| NatGatewaySet | Array of NatGateway | NAT gateway object array. |
| TotalCount | Integer | The number of NAT gateway objects meeting the conditions. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://vpc.tencentcloudapi.com/?Action=CreateNatGateway
&NatGatewayName=test_name
&VpcId=vpc-abcdefgh
&InternetMaxBandwidthOut=10
&MaxConcurrentConnection=1000000
&AddressCount=1
&PublicIpAddresses.0=139.199.232.119
&Tags.0.Key=city
&Tags.0.Value=shanghai
&<Common request parameters>
{
"Response": {
"NatGatewaySet": [
{
"NatGatewayId": "nat-cqbn23ju",
"NatGatewayName": "11111",
"VpcId": "vpc-qi4ja3sx",
"CreatedTime": "2019-07-16 09:40:00",
"State": "AVAILABLE",
"NetworkState": "AVAILABLE",
"InternetMaxBandwidthOut": 10,
"MaxConcurrentConnection": 1000000,
"PublicIpAddressSet": [
{
"AddressId": "eip-9uw5fwsu",
"PublicIpAddress": "139.199.232.119",
"IsBlocked": false
},
{
"AddressId": "eip-9uw5fsss",
"PublicIpAddress": "139.199.232.221",
"IsBlocked": false
}
],
"DestinationIpPortTranslationNatRuleSet": [],
"Zone": "ap-guangzhou-2",
"TagSet": [
{
"Key": "city",
"Value": "shanghai"
}
]
}
],
"TotalCount": 1,
"RequestId": "6f2a42cf-2905-4fa5-af49-0f01612550de"
}
}
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 |
|---|---|
| AddressQuotaLimitExceeded | The account quota is reached. Each Tencent Cloud account can create up to 20 EIPs in each region. |
| InternalServerError | Internal error. |
| InvalidAccount.NotSupported | This account is not supported. |
| InvalidAddressState | The operation cannot be performed on the specified EIP in current status. |
| InvalidParameter | A parameter error occurred. |
| InvalidParameterValue.LimitExceeded | The parameter value exceeds the limit. |
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| InvalidParameterValue.Range | The parameter value is not in the specified range. |
| InvalidParameterValue.TooLong | Invalid parameter value. The parameter value is too long. |
| InvalidVpcId.Malformed | Invalid VPC. The VPC instance ID is invalid. |
| InvalidVpcId.NotFound | Invalid VPC. The VPC resource does not exist. |
| LimitExceeded.AddressQuotaLimitExceeded | The number of EIPs applied for exceeds the upper limit. |
| LimitExceeded.DailyAllocateAddressQuotaLimitExceeded | The number of EIPs applied for exceeds the daily upper limit. |
| LimitExceeded.NatGatewayPerVpcLimitExceeded | The number of NAT gateways created by the VPC has reached the upper limit. |
| LimitExceeded.PublicIpAddressPerNatGatewayLimitExceeded | The number of EIPs bound to the NAT gateway has reached the upper limit. |
| ResourceInUse.Address | The specified IP address is already in use. |
| 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.InvalidState | Invalid resource status. |
| UnsupportedOperation.PublicIpAddressIsNotBGPIp | The EIP bound to the NAT gateway is not a BGP IP. |
| UnsupportedOperation.PublicIpAddressIsNotExisted | The EIP bound to the NAT gateway does not exist. |
| UnsupportedOperation.PublicIpAddressNotBilledByTraffic | The EIP bound to the NAT gateway is not bill-by-traffic. |
Was this page helpful?