创建NAT网关

最近更新时间:2019-08-01 17:27:05

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(CreateNatGateway)用于创建NAT网关。

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateNatGateway
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
NatGatewayName String NAT网关名称
VpcId String VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。
InternetMaxBandwidthOut Integer NAT网关最大外网出带宽(单位:Mbps),支持的参数值:20, 50, 100, 200, 500, 1000, 2000, 5000,默认: 100Mbps
MaxConcurrentConnection Integer NAT网关并发连接上限,支持参数值:1000000、3000000、10000000,默认值为100000
AddressCount Integer 需要申请的弹性IP个数,系统会按您的要求生产N个弹性IP,其中AddressCount和PublicAddresses至少传递一个。
PublicIpAddresses.N Array of String 绑定NAT网关的弹性IP数组,其中AddressCount和PublicAddresses至少传递一个。
Zone String 可用区,形如:ap-guangzhou-1

3. 输出参数

参数名称 类型 描述
NatGatewaySet Array of NatGateway NAT网关对象数组。
TotalCount Integer 符合条件的 NAT网关对象数量。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建NAT网关

输入示例

https://vpc.tencentcloudapi.com/?Action=CreateNatGateway
&NatGatewayName=test_name
&VpcId=vpc-abcdefgh
&InternetMaxBandwidthOut=10
&MaxConcurrentConnection=1000000
&AddressCount=1
&PublicIpAddresses.0=139.199.232.119
&<公共请求参数>

输出示例

{
  "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"
      }
    ],
    "TotalCount": 1,
    "RequestId": "6f2a42cf-2905-4fa5-af49-0f01612550de"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AddressQuotaLimitExceeded 账户配额不足,每个腾讯云账户每个地域下最多可创建 20 个 EIP。
InternalServerError 操作内部错误。
InvalidAccount.NotSupported 不支持此账户。
InvalidAddressState 指定EIP的当前状态不允许进行该操作。
InvalidParameter 入参不合法。
InvalidParameterValue.LimitExceeded 参数值超出限制。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.Range 参数值不在指定范围。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
InvalidVpcId.Malformed 无效的VPC,VPC实例ID不合法。
InvalidVpcId.NotFound 无效的VPC,VPC资源不存在。
LimitExceeded.NatGatewayPerVpcLimitExceeded 私有网络创建的NAT网关超过上限。
LimitExceeded.PublicIpAddressPerNatGatewayLimitExceeded NAT网关绑定的弹性IP超过上限。
ResourceInUse.Address 指定IP地址已经在使用中。
UnsupportedOperation 操作不支持。
UnsupportedOperation.InsufficientFunds 账户余额不足。
UnsupportedOperation.InvalidState 资源状态不合法。
UnsupportedOperation.PublicIpAddressIsNotBGPIp 绑定NAT网关的弹性IP不是BGP性质的IP。
UnsupportedOperation.PublicIpAddressIsNotExisted 绑定NAT网关的弹性IP不存在。
UnsupportedOperation.PublicIpAddressNotBilledByTraffic 绑定NAT网关的弹性IP不是按流量计费的。