1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (CreateNatGateway) is used to create NAT gateways.
Default interface request rate limit: 100 times per second.
Interface update time: 2020-11-13 02:54:07.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateNatGateway |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| NatGatewayName | Yes | No | String | NAT gateway name Example: demo_name |
| VpcId | Yes | No | String | VPC instance ID, which can be obtained through the VpcId returned by the DescribeVpcs API. Example: vpc-rkzpefgh |
| InternetMaxBandwidthOut | No | No | Uint64 | Maximum public bandwidth of a NAT gateway (unit: Mbps), which can be 20, 50, 100, 200, 500, 1000, 2000, and 5000. Default: 100 Mbps. Example: 10 |
| MaxConcurrentConnection | No | No | Uint64 | NAT gateway concurrent connection limit, supported values: 1000000, 3000000, and 10000000. The default value is 100000. Example: 1000000 |
| AddressCount | No | No | Uint64 | Number of EIPs to apply for. The system will produce N EIPs according to your request. At least either AddressCount or PublicAddresses must be input. Example: 1 |
| PublicIpAddresses | No | No | Array of String | Array of elastic IPs bound to NAT gateway, where either AddressCount or PublicAddresses must be provided. Example: ["139.199.232.119"] |
| Zone | No | No | String | Availability zone. For example, ap-region-1.Example: ap-region-1 |
| Tags | No | No | Array of Tag | Specifies the list of tags for binding. For example, [{"Key": "city", "Value": "region"}]. Example:View |
| InternetServiceProvider | No | No | String | ISP type Example: BGP |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| NatGatewaySet | Array of NatGateway | NAT gateway object array. Example:View |
| TotalCount | Uint64 | Number of eligible NAT gateway objects. Example: |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidVpcId.Malformed | Invalid VPC. The VPC instance ID is invalid. |
| InvalidVpcId.NotFound | Invalid VPC. The VPC resource does not exist. |
| InvalidParameter | Invalid input parameters. |
| UnsupportedOperation | Operation unsupported. |
| InvalidParameterValue.Malformed | Invalid input format. |
| InvalidParameterValue.LimitExceeded | The parameter value exceeds the limit. |
| InvalidParameterValue.Range | The parameter value is not within the specified range. |
| UnsupportedOperation.InvalidState | The resource status is invalid. |
| AddressQuotaLimitExceeded | Insufficient account quota. Each account can create up to 20 EIPs in each region. |
| InternalServerError | Internal operation error. |
| InvalidParameterValue.TooLong | Invalid input: Excessive length of the parameter. |
| InvalidAddressState | The current status of the specified EIP does not allow this operation. |
| UnsupportedOperation.InsufficientFunds | Insufficient account balance |
| ResourceInUse.Address | The specified IP address is already in use. |
| ResourceNotFound | The resource does not exist |
| InvalidAccount.NotSupported | This account is not supported. |
| LimitExceeded.NatGatewayPerVpcLimitExceeded | The number of NAT gateways created by VPC has exceeded the upper limit. |
| LimitExceeded.PublicIpAddressPerNatGatewayLimitExceeded | The number of elastic IPs bound to the NAT gateway has exceeded the upper limit. |
| UnsupportedOperation.PublicIpAddressIsNotExisted | The elastic IP bound to the NAT gateway does not exist. |
| UnsupportedOperation.PublicIpAddressIsNotBGPIp | The elastic IP address bound to NAT gateway is not an IP of BGP attribute. |
| UnsupportedOperation.PublicIpAddressNotBilledByTraffic | The elastic IP bound to the NAT gateway is not charged by traffic. |