使用CreateNatIp创建NAT IP地址-NAT网关-阿里云-NAT网关(NAT Gateway)-阿里云帮助中心

为VPC NAT网关实例创建NAT IP地址。

接口说明

CreateNatIp 接口属于异步接口，即系统会先返回一个 NAT IP 地址，但该 NAT IP 地址并未创建完成，系统后台的创建任务仍在进行。您可以调用 ListNatIps 查询 NAT IP 地址创建的状态：

当 NAT IP 地址处于 Creating 状态时，表示 NAT IP 地址正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。
当 NAT IP 地址处于 Available 状态时，表示 NAT IP 地址创建完成。

CreateNatIp 接口在同一个 NAT 网关内不支持并发创建 NAT IP 地址。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vpc:CreateNatIp

create

*NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	要创建 NAT IP 地址所属 NAT 网关实例的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	eu-central-1
NatGatewayId	string	是	NAT IP 地址所属的 VPC NAT 网关实例 ID。	ngw-gw8v16wgvtq26vh59****
NatIpName	string	否	创建的 NAT IP 地址的名称。长度为 2~128 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。但不能以`http://`或`https://`开头。	newnatip
NatIpDescription	string	否	创建的 NAT IP 地址的描述信息。长度为 2~256 个字符，必须以字母或中文开头，但不能以`http://`或`https://`开头。	test
DryRun	boolean	否	是否只预检此次请求，取值： true：发送检查请求，不会创建 NAT IP 地址。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 2xx HTTP 状态码并创建 NAT IP 地址。	false
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
NatIpCidr	string	是	创建 NAT IP 地址的地址段。	192.168.0.0/24
NatIp	string	否	创建的 NAT IP 地址。如果您不指定该 IP 地址，系统会在您的 NAT IP 地址段中随机分配一个 IP 地址。	192.168.0.34
RegionId	string	是	要创建 NAT IP 地址所属 NAT 网关实例的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	eu-central-1
Ipv4Prefix	string	否	创建的 IP 前缀地址段。该 IP 前缀地址段必须位于 NAT 所在交换机的预留网段内，且预留网段不能被占用。IP 前缀掩码必须为/28。	192.168.0.0/28
Ipv4PrefixCount	integer	否	自动分配的 IP 前缀数量。从 NAT 所在交换机的未分配预留网段内随机分配。取值范围：1~10。	1

返回参数

名称	类型	描述	示例值
	object	创建的 NAT IP 地址。
NatIp	string	创建的 NAT IP 地址。	192.168.0.34
RequestId	string	请求 ID。	E9AD97A0-5338-43F8-8A80-5E274CCBA11B
NatIpId	string	创建的 NAT IP 地址实例 ID。	vpcnatip-gw8y7q3cpk3fggs8****
Ipv4Prefix	string	旧接口返回的 Ipv4Prefix，已经废弃。	""
NatIps	array<object>	创建 NatIp 后返回的 NatIp 参数，当使用 IPv4Prefix 创建 NatIp 后将返回所有的 NatIp 信息，当创建单个 NatIp 时也推荐使用此参数获取 NatIp 信息。
	object	创建的 Ipv4Preix 时返回创建的 NatIpList 列表。
NatIp	string	创建的 Ipv4Preix 时返回创建的 NatIpList 列表的 NatIp 地址。	192.168.2.128
NatIpId	string	创建的 Ipv4Preix 时返回创建的 NatIpList 列表的 NatIpId。	vpcnatip-xxxxxxxx
Ipv4Prefix	string	创建的 Ipv4Preix 时返回创建的 NatIpList 列表的 Ipv4Prefix。	192.168.1.128/28

示例

正常返回示例

JSON格式

{
  "NatIp": "192.168.0.34",
  "RequestId": "E9AD97A0-5338-43F8-8A80-5E274CCBA11B",
  "NatIpId": "vpcnatip-gw8y7q3cpk3fggs8****",
  "Ipv4Prefix": "\"\"",
  "NatIps": [
    {
      "NatIp": "192.168.2.128",
      "NatIpId": "vpcnatip-xxxxxxxx",
      "Ipv4Prefix": "192.168.1.128/28"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	Mismatch.NatIpAndNatIpCidr	The %s and %s are mismatched.	%s和%s不匹配。
400	ResourceNotFound.NatGateway	The specified resource of %s is not found.
400	ResourceNotFound.NatIpCidr	The specified resource of %s is not found.	找不到指定的%s资源。
400	IncorrectStatus.NatGateway	%The status of %s [%s] is incorrect.	nat网关状态不正确
400	QuotaExceeded.NatIp	The quota of %s is exceeded, usage %s/%s.	NatIp和Ipv4Prefix配额使用溢出。
400	ResourceNotEnough.SwitchAvailableIps	The available private Ip number is not enough in your subnet.	子网中可用的私网IP不足。
400	ResourceNotEnough.NatIp	The specified resource of NatIp is not enough.	Insufficient IP addresses in the specified CIDR block.
400	ResourceAlreadyExist.NatIp	The specified resource of NatIp has already exist.	配置的NatIp已存在
400	Mismatch.Ipv4PrefixAndNatIpCidr	The %s and %s are mismatched.
400	Mismatch.Ipv4PrefixAndCidrReservations	The %s and %s are mismatched.	Ipv4Prefix和交换机预留网段不匹配。
400	ResourceAlreadyAssociated.Ipv4Prefix	%s is already associated.	Ipv4Prefix已经被分配。
400	ResourceNotEnough.Ipv4Prefix	The resource of %s is not enough.	Ipv4Prefix资源不足。
400	ResourceNotFound.Ipv4Prefix	The resource of s% is not found.	资源Ipv4Prefix不存在。
400	ResourceAlreadyAssociated.NatIp	The resource of %s was already associated.	NatIp资源已经被分配。
400	ResourceNotFound.NatIp	The specified resource of %s is not found.	NatIp资源找不到。
400	IllegalParam.Ipv4Prefix	The param of %s is illegal, must be /28 network segment.	参数Ipv4Prefix不合法，必须为/28网段
400	ResourceAlreadyExist.Ipv4Prefix	The specified resource of %s is already exist.	已经创建过该Ipv4Prefix,请勿重新创建。
400	QuotaExceeded.Ipv4Prefix	The quota of %s is exceeded, usage %s/%s.	Ipv4Prefix的配额使用溢出。
400	OperationFailed.InstanceNotSupport	natgateway not support ipv4prefix.	网关不支持Ipv4Prefix。
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

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

变更历史

更多信息，参考变更详情。