操作指南

API文档

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

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网关名称
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
Tags.N Array of Tag 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]
SubnetId String NAT网关所属子网
StockPublicIpAddressesBandwidthOut Integer 绑定NAT网关的弹性IP带宽大小(单位Mbps),默认为当前用户类型所能使用的最大值。
PublicIpAddressesBandwidthOut Integer 需要申请公网IP带宽大小(单位Mbps),默认为当前用户类型所能使用的最大值。
PublicIpFromSameZone Boolean 公网IP是否强制与NAT网关来自同可用区,true表示需要与NAT网关同可用区;false表示可与NAT网关不是同一个可用区。此参数只有当参数Zone存在时才能生效。

3. 输出参数

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

4. 示例

示例1 创建NAT网关

输入示例

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
                    },
                    {
                        "AddressId": "eip-9uw5fsss",
                        "PublicIpAddress": "139.199.232.221",
                        "IsBlocked": false
                    }
                ],
                "DestinationIpPortTranslationNatRuleSet": [],
                "DirectConnectGatewayIds": [],
                "Zone": "ap-guangzhou-2",
                "ExclusiveGatewayBandwidth": 1,
                "IsExclusive": true,
                "SourceIpTranslationNatRuleSet": [],
                "SubnetId": "1215354",
                "TagSet": [
                    {
                        "Key": "city",
                        "Value": "shanghai"
                    }
                ]
            }
        ],
        "TotalCount": 1,
        "RequestId": "6f2a42cf-2905-4fa5-af49-0f01612550de"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AddressQuotaLimitExceeded 账户配额不足,每个腾讯云账户每个地域下最多可创建 20 个 EIP。
InternalServerError 操作内部错误。
InvalidAccount.NotSupported 不支持此账户。
InvalidAddressState 指定EIP的当前状态不允许进行该操作。
InvalidParameter 参数错误。
InvalidParameterValue.EIPBrandWidthOutInvalid 值超过上限。
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地址已经在使用中。
ResourceNotFound 资源不存在。
UnauthorizedOperation.NoRealNameAuthentication 账号未实名。
UnsupportedOperation 操作不支持。
UnsupportedOperation.InsufficientFunds 账户余额不足。
UnsupportedOperation.InvalidState 资源状态不合法。
UnsupportedOperation.PublicIpAddressIsNotBGPIp 绑定NAT网关的弹性IP不是BGP性质的IP。
UnsupportedOperation.PublicIpAddressIsNotExisted 绑定NAT网关的弹性IP不存在。
UnsupportedOperation.PublicIpAddressNotBilledByTraffic 绑定NAT网关的弹性IP不是按流量计费的。
UnsupportedOperation.TagAllocate 标签正在分配中。
UnsupportedOperation.TagFree 标签正在释放中。
UnsupportedOperation.TagNotPermit 标签没有权限。
UnsupportedOperation.TagSystemReservedTagKey 不支持使用系统预留的标签键。
目录