调用CreateNatGateway接口创建NAT网关。

API描述

在调用本接口创建NAT网关时,请注意:

  • 首次创建增强型NAT网关时,系统会自动创建一个名称为AliyunServiceRoleForNatgw的服务关联角色,并且为该角色添加名称为AliyunServiceRolePolicyForNatgw的权限策略,授予NAT网关拥有访问其他云资源的权限。详细信息,请参见服务关联角色
    说明 如果您要创建的NAT网关类型为普通型NAT网关,系统不会自动创建名称为AliyunServiceRoleForNatgw的服务关联角色,也能成功创建NAT网关。
  • CreateNatGateway接口属于异步接口,即系统会先返回一个NAT网关实例ID,但该NAT网关实例并未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeNatGateways查询NAT网关的状态:
    • 当NAT网关处于Creating状态时,表示NAT网关正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当NAT网关处于Available状态时,表示NAT网关创建完成。
      说明 NAT网关创建一般需要1~3分钟,请您耐心等待。
  • NAT网关创建后,系统会在VPC的路由表中自动添加一条目标网段为0.0.0.0/0,下一跳为NAT网关的路由条目,用于将流量路由到NAT网关。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateNatGateway

要执行的操作,取值:CreateNatGateway

RegionId String cn-hangzhou

NAT网关所在的地域。

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

VpcId String vpc-bp1di7uewzmtvfuq8****

需要创建NAT网关的VPC的ID。指定VPC时,请注意:

如果您要创建的NAT网关类型为普通型NAT网关,请确保VPC路由表中没有目标网段为0.0.0.0/0的路由条目。如有,请先删除该路由条目。如果您创建的NAT网关类型是增强型NAT网关,则无此限制。

Name String fortest

NAT网关的名称。

名称长度为2~128个字符之间,必须以英文字母或中文开头,不能以http://https://开头,可包含数字、点号(.)、下划线(_)或短横线(-)。

如果没有指定该参数,默认使用网关ID作为名称。

Description String testnat

NAT网关的描述。

描述长度为2~256个字符之间,不能以http://https://开头。

ClientToken String shefffxxddjehfh123

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

Spec String Small

NAT网关的规格,取值:

  • Small(默认值):小型。
  • Middle:中型。
  • Large:大型。
  • XLarge.1:超大型-1。
InstanceChargeType String PostPaid

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

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

PrePaid:包年包月。

包年包月和按量付费的详细信息,请参见包年包月按量付费

PricingCycle String Month

包年包月的计费周期,取值:

Month(默认值):按月付费。

Year:按年付费。

InstanceChargeType参数的值为PrePaid时,该参数必选;当InstanceChargeType参数的值为PostPaid时,该参数可不填。

Duration String 1

购买时长。

PricingCycle取值Month时,Period取值范围为1~9

PricingCycle取值Year时,Period取值范围为1~3

如果InstanceChargeType参数的值为PrePaid时,该参数必选。

AutoPay Boolean false

是否自动付费,取值:

false:不开启自动付费,生成订单后需要到订单中心完成支付。

true:开启自动付费,自动支付订单。

InstanceChargeType参数的值为PrePaid时,该参数必选;当InstanceChargeType参数的值为PostPaid时,该参数不填。

VSwitchId String vsw-bp1e3se98n9fq8hle****

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

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

  • 如果您要在存量交换机中创建增强型NAT网关,请确保交换机所属的可用区支持创建增强型NAT网关,且交换机有可用的IP。
  • 如果您还未创建交换机,请先在支持创建增强型NAT网关的可用区创建交换机,然后再指定增强型NAT网关所属的交换机。

您可以通过ListEnhanhcedNatGatewayAvailableZones接口查询增强型NAT网关的资源可用区,通过DescribeVSwitches接口查询交换机中的可用IP数。

NatType String Enhanced

NAT网关的类型,取值:

说明 目前,仅在西南1(成都)、英国(伦敦)、德国(法兰克福)、马来西亚(吉隆坡)和印度(孟买)地域创建NAT网关,NAT网关类型默认为Enhanced
InternetChargeType String PayBySpec

NAT网关的计费类型,取值:

  • PayBySpec:按固定规格计费。
  • PayByLcu:按使用量计费。
说明 目前,仅在德国(法兰克福)和英国(伦敦)地域下,且仅NatType取值为Enhanced时,InternetChargeType才支持取值为PayByLcu

返回数据

名称 类型 示例值 描述
NatGatewayId String ngw-112za33e4****

创建的NAT网关的实例ID。

ForwardTableIds List ftb-11tc6xgmv****

DNAT列表。

RequestId String 2315DEB7-5E92-423A-91F7-4C1EC9AD97C3

请求ID。

SnatTableIds List stb-SnatTableIds****

SNAT列表。

示例

请求示例

https://vpc.aliyuncs.com/?Action=CreateNatGateway
&RegionId=cn-hangzhou
&VpcId= vpc-bp1di7uewzmtvfuq8****
&<公共请求参数>

正常返回示例

XML 格式

<CreateNatGatewayResponse>
      <RequestId>5AF873FB-6669-4AD5-A4DA-478D535C8F0D</RequestId>
      <SnatTableIds>
            <SnatTableId>stb-bp1evej8rk6ww1djl****</SnatTableId>
      </SnatTableIds>
      <ForwardTableIds>
            <ForwardTableId>ftb-bp1d09hosgndxs154****</ForwardTableId>
      </ForwardTableIds>
      <NatGatewayId>ngw-bp1m842e0dz1t5cos****</NatGatewayId>
</CreateNatGatewayResponse>

JSON 格式

{
	"RequestId": "5AF873FB-6669-4AD5-A4DA-478D535C8F0D",
	"SnatTableIds": {
		"SnatTableId": [
			"stb-bp1evej8rk6ww1djl****"
		]
	},
	"ForwardTableIds": {
		"ForwardTableId": [
			"ftb-bp1d09hosgndxs154****"
		]
	},
	"NatGatewayId": "ngw-bp1m842e0dz1t5cos****"
}