1. 接口描述
接口请求域名: vpc.api3.gsesgpucloud.com。
本接口(CreateNatGateway)用于创建NAT网关。
默认接口请求频率限制:100次/秒。
接口更新时间:2020-11-11 18:54:07。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:CreateNatGateway |
Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
NatGatewayName | 是 | 否 | String | NAT网关名称 示例值: |
VpcId | 是 | 否 | String | VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。 示例值: |
InternetMaxBandwidthOut | 否 | 否 | Uint64 | NAT网关最大外网出带宽(单位:Mbps),支持的参数值:20, 50, 100, 200, 500, 1000, 2000, 5000 ,默认: 100Mbps 。示例值: |
MaxConcurrentConnection | 否 | 否 | Uint64 | NAT网关并发连接上限,支持参数值:1000000、3000000、10000000 ,默认值为100000 。示例值: |
AddressCount | 否 | 否 | Uint64 | 需要申请的弹性IP个数,系统会按您的要求生产N个弹性IP,其中AddressCount和PublicAddresses至少传递一个。 示例值: |
PublicIpAddresses | 否 | 否 | Array of String | 绑定NAT网关的弹性IP数组,其中AddressCount和PublicAddresses至少传递一个。 示例值: |
Zone | 否 | 否 | String | 可用区,形如:ap-guangzhou-1 。示例值: |
Tags | 否 | 否 | Array of Tag | 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}] 示例值:查看 |
InternetServiceProvider | 否 | 否 | String | 运营商类型 示例值: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NatGatewaySet | NatGateway | NAT网关对象数组。 示例值:查看 |
TotalCount | Uint64 | 符合条件的 NAT网关对象数量。 示例值: |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidVpcId.Malformed | 无效的VPC,VPC实例ID不合法。 |
InvalidVpcId.NotFound | 无效的VPC,VPC资源不存在。 |
InvalidParameter | 入参不合法。 |
UnsupportedOperation | 操作不支持。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
UnsupportedOperation.InvalidState | 资源状态不合法。 |
AddressQuotaLimitExceeded | 账户配额不足,每个账户每个地域下最多可创建 20 个 EIP。 |
InternalServerError | 操作内部错误。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
InvalidAddressState | 指定EIP的当前状态不允许进行该操作。 |
UnsupportedOperation.InsufficientFunds | 账户余额不足。 |
ResourceInUse.Address | 指定IP地址已经在使用中。 |
InvalidAccount.NotSupported | 不支持此账户。 |
LimitExceeded.NatGatewayPerVpcLimitExceeded | 私有网络创建的NAT网关超过上限。 |
LimitExceeded.PublicIpAddressPerNatGatewayLimitExceeded | NAT网关绑定的弹性IP超过上限。 |
UnsupportedOperation.PublicIpAddressIsNotExisted | 绑定NAT网关的弹性IP不存在。 |
UnsupportedOperation.PublicIpAddressIsNotBGPIp | 绑定NAT网关的弹性IP不是BGP性质的IP。 |
UnsupportedOperation.PublicIpAddressNotBilledByTraffic | 绑定NAT网关的弹性IP不是按流量计费的。 |