1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateNatGateway)用于创建NAT网关。
在对新建的NAT网关做其他操作前,需先确认此网关已被创建完成(DescribeNatGateway接口返回的实例State字段为AVAILABLE)。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateNatGateway。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
NatGatewayName | 是 | String | NAT网关名称 示例值:test_name |
VpcId | 是 | String | VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。 示例值:vpc-abcdefgh |
InternetMaxBandwidthOut | 否 | Integer | NAT网关最大外网出带宽(单位:Mbps),支持的参数值:20, 50, 100, 200, 500, 1000, 2000, 5000,默认: 100Mbps。 当以下NatProductVersion参数值为2即标准型时,此参数无需填写,默认为5000Mbps。 示例值:10 |
MaxConcurrentConnection | 否 | Integer | NAT网关并发连接数上限,支持参数值:1000000、3000000、10000000,默认值为100000。 当以下NatProductVersion参数值为2即标准型时,此参数无需填写,默认为2000000。 示例值:1000000 |
AddressCount | 否 | Integer | 新建弹性公网IP个数,系统会按您的要求创建对应数量的弹性公网IP,其中AddressCount和PublicAddresses两个参数至少填写一个。 示例值:1 |
PublicIpAddresses.N | 否 | Array of String | 绑定NAT网关的已有弹性公网IP数组,其中AddressCount和PublicAddresses两个参数至少填写一个。 示例值:["139.199.232.119"] 示例值:["139.199.232.119"] |
Zone | 否 | String | 可用区,形如:ap-guangzhou-1 。示例值:ap-guangzhou-1 |
Tags.N | 否 | Array of Tag | 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}] |
StockPublicIpAddressesBandwidthOut | 否 | Integer | 绑定NAT网关的弹性公网IP带宽值(单位:Mbps)。不填写此参数时:则该参数默认为弹性公网IP的带宽值,部分用户默认为该用户类型的弹性公网IP的带宽上限。 示例值:77 |
PublicIpAddressesBandwidthOut | 否 | Integer | 需要申请公网IP带宽大小(单位Mbps),默认为当前用户类型所能使用的最大值。 示例值:77 |
PublicIpFromSameZone | 否 | Boolean | 公网IP是否强制与NAT网关来自同可用区,true表示需要与NAT网关同可用区;false表示可与NAT网关不是同一个可用区。此参数只有当参数Zone存在时才能生效。 示例值:false |
NatProductVersion | 否 | Integer | NAT网关类型,1表示传统型NAT网关,2表示标准型NAT网关,默认值是1。 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NatGatewaySet | Array of NatGateway | NAT网关对象数组。 |
TotalCount | Integer | 符合条件的 NAT网关对象数量。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建NAT网关
创建一个传统型NAT网关并自动分配一个EIP
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateNatGateway
<公共请求参数>
{
"VpcId": "vpc-abcdefgh",
"PublicIpAddresses": [
"139.199.232.119"
],
"MaxConcurrentConnection": "1000000",
"Tags": [
{
"Value": "shanghai",
"Key": "city"
}
],
"InternetMaxBandwidthOut": "10",
"NatGatewayName": "test_name",
"AddressCount": "1"
}
输出示例
{
"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,
"SecurityGroupSet": [],
"PublicIpAddressSet": [
{
"AddressId": "eip-9uw5fwsu",
"PublicIpAddress": "139.199.232.119",
"IsBlocked": false,
"BlockType": "NORMAL"
},
{
"AddressId": "eip-9uw5fsss",
"PublicIpAddress": "139.199.232.221",
"IsBlocked": false,
"BlockType": "NORMAL"
}
],
"DestinationIpPortTranslationNatRuleSet": [],
"DirectConnectGatewayIds": [],
"Zone": "ap-guangzhou-2",
"ExclusiveGatewayBandwidth": 1,
"IsExclusive": true,
"SmartScheduleMode": false,
"DedicatedClusterId": "",
"NatProductVersion": 1,
"RestrictState": "NORMAL",
"SourceIpTranslationNatRuleSet": [],
"SubnetId": "1215354",
"TagSet": [
{
"Key": "city",
"Value": "shanghai"
}
]
}
],
"TotalCount": 1,
"RequestId": "6f2a42cf-2905-4fa5-af49-0f01612550de"
}
}
示例2 创建标准型NAT网关
创建一个标准型NAT网关并自动分配一个EIP
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateNatGateway
<公共请求参数>
{
"SubnetId": "subnet-q1b8fsg",
"AddressCount": "1",
"NatGatewayName": "xiaooliang_test",
"VpcId": "vpc-bohigpb7",
"NatProductVersion": "2"
}
输出示例
{
"Response": {
"NatGatewaySet": [
{
"NatGatewayId": "nat-o49t53q2",
"NatGatewayName": "xiaooliang_test",
"VpcId": "vpc-bohigpb7",
"State": "PENDING",
"NetworkState": "AVAILABLE",
"InternetMaxBandwidthOut": 100,
"MaxConcurrentConnection": 1000000,
"PublicIpAddressSet": [],
"DestinationIpPortTranslationNatRuleSet": [],
"CreatedTime": "0000-00-00 00:00:00",
"Zone": "",
"TagSet": [],
"DirectConnectGatewayIds": [],
"SubnetId": "subnet-q1b8fsgu",
"SecurityGroupSet": [],
"SourceIpTranslationNatRuleSet": [],
"IsExclusive": false,
"SmartScheduleMode": false,
"DedicatedClusterId": null,
"RestrictState": "NORMAL",
"NatProductVersion": 2,
"ExclusiveGatewayBandwidth": null
}
],
"TotalCount": 1,
"RequestId": "7b00a07c-7358-4f0a-b81c-8ce5882a87b8"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AddressQuotaLimitExceeded | 账户配额不足,每个腾讯云账户每个地域下最多可创建 20 个 EIP。 |
InternalError.ModuleError | 内部模块错误。 |
InternalServerError | 操作内部错误。 |
InvalidAccount.NotSupported | 不支持此账户。 |
InvalidAddressState | 指定EIP的当前状态不允许进行该操作。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.EIPBrandWidthOutInvalid | 值超过上限。 |
InvalidParameterValue.Empty | 缺少参数。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
InvalidParameterValue.TagDuplicateKey | 标签键重复。 |
InvalidParameterValue.TagDuplicateResourceType | 重复的标签资源类型。 |
InvalidParameterValue.TagInvalidKey | 标签键无效。 |
InvalidParameterValue.TagInvalidKeyLen | 标签键长度无效。 |
InvalidParameterValue.TagInvalidVal | 标签值无效。 |
InvalidParameterValue.TagKeyNotExists | 标签键不存在。 |
InvalidParameterValue.TagNotAllocatedQuota | 标签没有分配配额。 |
InvalidParameterValue.TagNotExisted | 该标签不存在。 |
InvalidParameterValue.TagNotSupportTag | 不支持的标签。 |
InvalidParameterValue.TagResourceFormatError | 标签资源格式错误。 |
InvalidParameterValue.TagTimestampExceeded | 标签时间戳超配。 |
InvalidParameterValue.TagValNotExists | 标签值不存在。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
InvalidVpcId.Malformed | 无效的VPC,VPC实例ID不合法。 |
InvalidVpcId.NotFound | 无效的VPC,VPC资源不存在。 |
LimitExceeded.AddressQuotaLimitExceeded | 租户申请的弹性IP超过上限。 |
LimitExceeded.DailyAllocateAddressQuotaLimitExceeded | 租户每天申请的弹性IP超过上限。 |
LimitExceeded.NatGatewayLimitExceeded | NAT网关数量已达到上限。 |
LimitExceeded.NatGatewayPerVpcLimitExceeded | 私有网络创建的NAT网关超过上限。 |
LimitExceeded.PublicIpAddressPerNatGatewayLimitExceeded | NAT网关绑定的弹性IP超过上限。 |
LimitExceeded.TagKeyExceeded | 标签键已达到上限。 |
LimitExceeded.TagKeyPerResourceExceeded | 每个资源的标签键已达到上限。 |
LimitExceeded.TagNotEnoughQuota | 没有足够的标签配额。 |
LimitExceeded.TagQuota | 标签配额已满,无法创建资源。 |
LimitExceeded.TagQuotaExceeded | 标签配额已达到上限。 |
LimitExceeded.TagTagsExceeded | 标签键的数目已达到上限。 |
ResourceInUse.Address | 指定IP地址已经在使用中。 |
ResourceInsufficient.Instance | 指定实例类型已售罄。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.NoRealNameAuthentication | 账号未实名。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.InsufficientFunds | 账户余额不足。 |
UnsupportedOperation.InsufficientInternetServiceProviders | 至少需要两个运营商 |
UnsupportedOperation.InvalidState | 资源状态不合法。 |
UnsupportedOperation.NatGatewayHadEipUnassociate | NAT网关存在未解绑的IP。 |
UnsupportedOperation.NotSupportZone | 不支持的可用区 |
UnsupportedOperation.PublicIpAddressIsNotBGPIp | 绑定NAT网关的弹性IP不是BGP性质的IP。 |
UnsupportedOperation.PublicIpAddressIsNotExisted | 绑定NAT网关的弹性IP不存在。 |
UnsupportedOperation.PublicIpAddressNotBilledByTraffic | 绑定NAT网关的弹性IP不是按流量计费的。 |
UnsupportedOperation.TagAllocate | 标签正在分配中。 |
UnsupportedOperation.TagFree | 标签正在释放中。 |
UnsupportedOperation.TagNotPermit | 标签没有权限。 |
UnsupportedOperation.TagSystemReservedTagKey | 不支持使用系统预留的标签键。 |