CreateNatGateway - 创建NAT网关

调用CreateNatGateway接口创建增强型公网NAT网关或VPC NAT网关。

接口说明

在调用本接口时,请了解以下内容:

  • 首次创建 NAT 网关时,系统会自动创建一个名称为 AliyunServiceRoleForNatgw 的服务关联角色,并且为该角色添加名称为 AliyunServiceRolePolicyForNatgw 的权限策略,授予 NAT 网关拥有访问其他云资源的权限。更多信息,请参见服务关联角色

  • 增强型公网 NAT 网关创建后,系统会在 VPC 的路由表中自动添加一条目标网段为 0.0.0.0/0,下一跳为 NAT 网关的路由条目,用于将流量路由到 NAT 网关。

  • CreateNatGateway 接口属于异步接口,即系统会先返回一个 NAT 网关(公网 NAT 网关或 VPC NAT 网关)实例 ID,但该 NAT 网关实例并未创建完成,系统后台的创建任务仍在进行。您可以调用 DescribeNatGateways 查询 NAT 网关的状态。

    • 当 NAT 网关处于 Creating 状态时,表示 NAT 网关正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。

    • 当 NAT 网关处于 Available 状态时,表示 NAT 网关创建完成。

NAT 网关创建一般需要 1~3 分钟,请您耐心等待。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:CreateNatGatewaycreate
  • NatGateway
    acs:vpc:{#regionId}:{#accountId}:natgateway/*

请求参数

名称类型必填描述示例值
RegionIdstring

NAT 网关所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
VpcIdstring

需要创建 NAT 网关的 VPC 的 ID。

vpc-bp1di7uewzmtvfuq8****
Namestring

NAT 网关的名称。

名称长度为 2~128 个字符,以大小写字母或中文开头,可包含数字、下划线(_)和短划线(-)。

如果没有指定该参数,系统会为 NAT 网关创建默认的名称。

fortest
Descriptionstring

NAT 网关的描述。

描述可以为空;或填写 2~256 个字符,不能以http://https://开头。

testnat
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

由客户端生成该参数值,要保证在不同请求间唯一。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
5A2CFF0E-5718-45B5-9D4D-70B3FF3898
Specstring

包年包月公网 NAT 网关已停止新购,该参数不再使用。

无效参数
InstanceChargeTypestring

NAT 网关的付费模式,取值:

PostPaid(默认值):按量付费。

更多信息,请参见公网 NAT 网关计费VPC NAT 网关计费

PostPaid
PricingCyclestring

包年包月公网 NAT 网关已停止新购,该参数不再使用。

无效参数
Durationstring

包年包月公网 NAT 网关已停止新购,该参数不再使用。

无效参数
AutoPayboolean

包年包月公网 NAT 网关已停止新购,该参数不再使用。

无效参数
VSwitchIdstring

NAT 网关所属的交换机的 ID。

创建 NAT 网关时,您必须指定 NAT 网关所属的交换机,系统会为 NAT 网关分配一个交换机内的空闲私网 IP 地址。

  • 如果您要在存量交换机中创建 NAT 网关,请确保交换机所属的可用区支持创建 NAT 网关,且交换机有可用的 IP。

  • 如果您还未创建交换机,请先在支持创建 NAT 网关的可用区创建交换机,然后再指定 NAT 网关所属的交换机。

说明 您可以通过 ListEnhanhcedNatGatewayAvailableZones 接口查询 NAT 网关的资源可用区,通过 DescribeVSwitches 接口查询交换机中的可用 IP 数。
vsw-bp1e3se98n9fq8hle****
NatTypestring

NAT 网关的类型,取值:Enhanced,增强型 NAT 网关。

Enhanced
InternetChargeTypestring

NAT 网关的计费类型,取值:PayByLcu,表示按使用量计费。

PayByLcu
NetworkTypestring

创建的 NAT 网关类型,取值:

  • internet:公网 NAT 网关。

  • intranet:VPC NAT 网关。

internet
SecurityProtectionEnableddeprecatedboolean

是否开启防火墙功能,取值:

  • false(默认值):不开启。
    注意 该参数已弃用。
false
IcmpReplyEnabledboolean

是否开启 ICMP 代回。取值:

  • true(默认值):开启。
  • false:不开启。
true
PrivateLinkEnabledboolean

默认不支持私网链接。设置为 true 则意味着支持私网链接

EipBindModestring

NAT 网关的 EIP 绑定模式,取值:

  • MULTI_BINDED(默认值):多 EIP 网卡可见模式。
  • NAT:EIP 普通模式,兼容 IPv4 网关。
    说明 NAT 网关的 EIP 绑定模式为 EIP 普通模式时,EIP 将占用 NAT 网关所在交换机的一个私网 IP,请确保 NAT 网关所在交换机内私网 IP 地址充足,如果 NAT 网关所在的交换机没有可用的空闲私网地址时,将无法绑定新的 EIP。NAT 网关的 EIP 绑定模式为 EIP 普通模式时,NAT 网关支持绑定的 EIP 数量上限为 50 个。
MULTI_BINDED
Tagarray<object>

标签列表。

MULTI_BINDED
object
Keystring

标签键。API 调用时使用 Tag.N.Key 的形式,N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 或 acs:开头,不能包含 http://或 https://。

TestKey
Valuestring

标签值。API 调用时使用 Tag.N.Value 的形式,N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 或 acs:开头,不能包含 http://或 https://。

TestValue
AccessModeobject

反向访问 VPC NAT 网关的访问模式。

ModeValuestring

访问模式取值:

  • route:路由模式。

  • tunnel:隧道模式。

说明 当此字段取值时,PrivateLinkEnabled 字段,必须为:true
route
TunnelTypestring

隧道模式类型:

  • geneve: Geneve 类型。
说明 当访问模式为隧道模式时此值有效。

返回参数

名称类型描述示例值
object

返回数据结构体。

NatGatewayIdstring

创建的 NAT 网关的实例 ID。

ngw-112za33e4****
RequestIdstring

请求 ID。

2315DEB7-5E92-423A-91F7-4C1EC9AD97C3
ForwardTableIdsarray

DNAT 列表。

ForwardTableIdstring

DNAT 列表。

ftb-11tc6xgmv****
SnatTableIdsarray

SNAT 列表。

SnatTableIdstring

SNAT 列表。

stb-SnatTableIds****
FullNatTableIdsarray

FULLNAT 列表。

FullNatTableIdstring

FULLNAT 列表。

fulltb-gw88z7hhlv43rmb26****

示例

正常返回示例

JSON格式

{
  "NatGatewayId": "ngw-112za33e4****",
  "RequestId": "2315DEB7-5E92-423A-91F7-4C1EC9AD97C3",
  "ForwardTableIds": {
    "ForwardTableId": [
      "ftb-11tc6xgmv****"
    ]
  },
  "SnatTableIds": {
    "SnatTableId": [
      "stb-SnatTableIds****"
    ]
  },
  "FullNatTableIds": {
    "FullNatTableId": [
      "fulltb-gw88z7hhlv43rmb26****"
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.NatPayBySpecPay-by-specification NAT is no longer supported. Newly purchased pay-as-you-go NAT gateways only support the pay-by-CU metering method.按规格计费的NAT网关已经不再进行售卖,请选择按CU使用量计费的NAT网关
400UnsupportedFeature.PrivateLinkThe feature of %s is not supported.-
400DependencyViolation.FullNatEntryThe specified resource of %s depends on %s, so the operation cannot be completed.-
400UnsupportedFeature.InternetChargeTypeThe feature of InternetChargeType is not supported.-
400InvalidVPCStatusvpc incorrect status.该 VPC 状态非法,请您检查 VPC 状态是否输入正确。
400InvalidNatGatewayName.MalFormedNatGateway name is not valid.网关名称不合法。
400InvalidNatGatewayDescription.MalFormedNatGateway description is not valid.网关描述不合法。
400MissingParameter.BandwidthPackageonly support one BandwidthPackage be created with NatGateway.必须指定一个共享带宽包。
400OperationDeniedThe user cannot allow to create natgw, please call PD to authorize-
400RouterEntryConflict.DuplicatedA route entry already exists, which CIDR is '0.0.0.0/0'-
400MissingParameterMiss mandatory parameter.缺少必要参数,请您检查必填参数是否都已填后再进行操作。
400QuotaExceeded.BandwidthPackageIpsThe specified ipCount exceeded quota.IP数量超过上限,可以在配额管理页面申请增加配额。
400AllocateIpFailedAlloc bandwidthPackage ips failed, maybe no available ip.-
400InvalidParameter.Name.MalformedThe specified Name is not valid.该名称不合法,请您按照正确的格式书写名称。
400InvalidParameter.Description.MalformedThe specified Description is not valid.该描述不合法。
400ZONE_NO_AVAILABLE_IPThe Zone have no available ip.该可用区没有可用IP。
400ParameterIllegalipCount,bandwidth parameter invalid-
400InvalidParameter.BandwidthPackage.n.ISP.ValueNotSupportThe specified ISP of BandwidthPackage is not valid.该共享带宽包的ISP不合法。
400InvalidNatGatewayId.NotFoundThe NatGatewayId not exist.指定的 NatGatewayId 不存在,请您检查填写的 NatGatewayId 是否正确。
400VswitchStatusErrorThe VSwitch is creating .交换机正在创建中。
400VpcStatusErrorThe Vpc is creating .正在创建VPC。
400InvalidParameter.Spec.ValueNotSupportedThe specified Spec is not valid.该规格不合法。
400TaskConflictThe operation is too frequent, TaskConflict.操作太频繁,请稍后重试
400COMMODITY.INVALID_COMPONENTThe instance component is invalid.销售模块参数不满足约束检查
400CreateNatGateway.RouteConflict.DynamicRouteRoute conflict exists in routing table.-
400OperationUnsupported.MultiNatGatewayMore than one natGateway per vpc is unsupported.-
400Forbidden.CheckEntryRuleQuotaRoute entry quota rule check error.检查路由条目配额时发生了错误。
400OperationFailed.UnpaidBillsExistThe account has unpaid bills. Please pay your overdue bill first.此账户有未支付的订单。
400IncorrectStatus.RouteEntrySpecified routeEntry status error.-
400OperationFailed.RiskControlRisk control check failed.我们检测到您的付款方式存在安全风险。请通过电子邮件或控制台消息中的链接继续验证,并在验证后重新提交订单。
400IncorrectStatus.RouteTableStatus%s-
400OperationFailed.TokenVerfiyToken verify failed.-
400%s%s-
400IllegalParam.NameThe specified Name is invalid, shorter than 2 characters.-
400OperationFailed.EnhancedQuotaExceedEnhanced nat gateway per vpc quota is exceeded当前vpc下创建增强型nat网关配额超限
400OrderError.NoAvailablePaymentMethod%s-
400OrderError.BasicInfoUncompleted%s-
400OperationUnsupported.EnhancedCURegion%s-
400NoPermission.CreateServiceLinkedRoleYou are not authorized to create service linked role-
400OperationUnsupported.EnhancedRegion%s-
400OperationFailed.EnhancedInventoryNotEnoughOperation failed because inventory is not enough.-
400OperationFailed.VswNotBelongToVpcOperation failed because the specified VSwitch is not bound to the same VPC with NAT gateway.操作失败,因为交换机和NAT网关不属于同一个VPC。
400OperationFailed.EnhancedUserIsUnAuthorizedOperation failed because the user is not authorized to create an enhanced NAT gateway.操作失败因为用户未授权创建增强型NAT网关。
400OperationUnsupported.PrePaidPyByLcuThe operation failed because the subscription NAT gateway does not support the pay-by-LCU billing method.预付费的NAT网关实例不支持PayByLcu的计费方式。
400OperationFailed.NormalInventoryNotEnoughStandard NAT gateways are no longer offered. You can create enhanced NAT gateways and set the correct natType.普通型NAT网关已不支持创建,请创建增强型NAT网关并确保正确配置NatType参数。
400OperationFailed.VSwitchNoAvailableIpOperation failed because the specified vswitch does not have availabe ip.-
400UnsupportedFeature.IcmpReplyEnabledThe feature of IcmpReplyEnabled is not supported.Icmp 代答使能功能修改不支持。
400UnsupportedFeature.SecurityProtectionEnabledThe feature of SecurityProtectionEnabled is not supported.-
400OperationFailed.RegionConvertOperation failed because do not find region info.-
400OperationFailed.EnhancedUserIsUnAuthorizedOperation failed because user is unauthorized service account.-
400UnsupportedFeature.VpcNatThe feature of VpcNat is not supported.-
400InvalidVSWITCHID.NotFoundThe specified resource of %s is not found.-
400Forbidden.OperateShareResourceOperate share resource is forbidden.-
400IncorrectStatus.VSWITCHThe status of VSWITCH is incorrect.-
400OperationFailed.VpcNatGatewayInventoryNotEnoughThe operation is failed because of inventory is not enough.-
400OperationFailed.VpcNatGatewayCheckInventoryThe operation is failed because of check inventory result is unexpected-
400ExclusiveParam.%sAnd%sThe param of %s and %s are mutually exclusive.参数 %s 和 %s 相互排斥。
400SecurityGroupType.NotSupportedThe specified security group type is not supported.安全组已经被托管,不能使用
400SecurityGroup.NotExistThe specified security group is not exist.安全组不存在于此VPC。
400OperationFailed.ContainForbiddenLabelThere is a label that prohibits ordering, please contact your distributor for processing.存在禁止下单的标签,请联系您的分销商处理。
400OperationDenied.PrePaidInstanceThe operation is not allowed because prepaid instance is no longer supported.预付费实例不再支持购买。
400UnsupportedFeature.GeneveThe feature of Geneve is not supported.当前不支持创建Geneve模式的NAT网关。
400OperationFailed.NoAvailableResourceThe Zone have no available resource.区域没有可用资源。
400ExclusiveParam.AccessModeValueAndAccessTunnelTypeThe specified param AccessModeValue and AccessTunnelType are mutually exclusive.指定的入参AccessMode.ModeValue和AccessMode.TunnelType存在冲突
400ExclusiveParam.PrivateLinkModeAndAccessModeThe specified param PrivateLinkMode and AccessMode are mutually exclusive.指定的入参PrivateLinkMode和AccessMode存在冲突
400ExclusiveParam.PrivateLinkEnabledAndAccessModeThe specified paramPrivateLinkEnabled and AccessMode are mutually exclusive.指定的入参PrivateLinkEnabled和AccessMode存在冲突
400UnsupportedFeature.AccessModeValueThe feature of AccessMode.ModeValue(%s) is not supported.VPC NAT的AccessMode.ModeValue属性不支持此操作
400IllegalParam.AccessTunnelTypeThe request parameter AccessMode.TunnelType is illegal.请求参数中AccessMode.TunnelType参数不合法
400IllegalParam.AccessModeValueThe request parameter AccessMode.ModeValue is illegal.请求参数中AccessMode.ModeValue参数不合法
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。
404InvalidVpcId.NotFoundSpecified value of VpcId is not found in our record.该VPC不存在,请您检查输入的VPC是否正确。
404InvalidZoneId.NotFoundSpecified value of ZoneId is not exists.该可用区不存在。
404InvalidZoneId.NotFoundCan not find ZoneId for allocated ip.该IP的可用区不正确。
404VPC_ONLY_CAN_CREATE_ONE_NAT_GATEWAYNatGateway in one vpc support only one.-
404OperationFailed.CrateEntryTimeOutOperation failed because create custom routeEntry timeout.-
404Forbidden.CreateSpecialSpecNatGatewayYou are not authorized to create special spec nat gateway.-
404UnsupportedZoneForFwNatThe zone is unsupported for FW NAT.该可用区不支持防护型NAT网关。
500OrderError.NatGatewayThe Account failed to create order.-
500OperationFailed.AccessTunnelIdAccessTunnelId param do operation failed.VPC NAT生成隧道Id失败, 请稍后重试
500OperationFailed.EnhancedCheckInventoryThe NAT gateway in the current zone is not in service, or the resource inventory is insufficient.当前可用区NAT网关未开服, 或底层资源库存不足。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-10-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-08-15OpenAPI 错误码发生变更查看变更详情
2024-05-06OpenAPI 错误码发生变更查看变更详情
2024-01-18OpenAPI 错误码发生变更查看变更详情
2023-12-14OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-06-30OpenAPI 错误码发生变更查看变更详情
2023-03-01OpenAPI 错误码发生变更查看变更详情
2023-01-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2022-08-12OpenAPI 错误码发生变更查看变更详情
2022-08-03OpenAPI 错误码发生变更查看变更详情
2022-07-22OpenAPI 错误码发生变更查看变更详情