调用CreateNatIp接口创建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代码示例。

请求参数

名称 类型 是否必选 示例值 描述
RegionId String eu-central-1

要创建NAT IP地址所属NAT网关实例的地域ID。

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

NatGatewayId String ngw-gw8v16wgvtq26vh59****

NAT IP地址所属的VPC NAT网关实例ID。

NatIpName String newnatip

创建的NAT IP地址的名称。

长度为2~128个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。但不能以http://https://开头。

NatIpDescription String test

创建的NAT IP地址的描述信息。

长度为2~256个字符,必须以字母或中文开头,但不能以http://https://开头。

DryRun Boolean false

是否只预检此次请求,取值:

  • true:发送检查请求,不会创建NAT IP地址。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回2xx HTTP状态码并创建NAT IP地址。
ClientToken String 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

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

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
NatIpCidr String 192.168.0.0/24

创建NAT IP地址的地址段。

NatIpCidrId String vpcnatip-gw8y7q3cpk3fggs87****

创建NAT IP地址的地址段实例ID。

NatIp String 192.168.0.34

创建的NAT IP地址。

如果您不指定该IP地址,系统会在您的NAT IP地址段中随机分配一个IP地址。

Action String CreateNatIp

系统规定参数。取值:CreateNatIp

返回数据

名称 类型 示例值 描述
NatIp String 192.168.0.34

创建的NAT IP地址。

RequestId String E9AD97A0-5338-43F8-8A80-5E274CCBA11B

请求ID。

NatIpId String vpcnatip-gw8y7q3cpk3fggs8****

创建的NAT IP地址实例ID。

示例

请求示例

http(s)://[Endpoint]/?RegionId=eu-central-1
&NatGatewayId=ngw-gw8v16wgvtq26vh59****
&NatIpName=newnatip
&NatIpDescription=test
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&NatIpCidr=192.168.0.0/24
&NatIpCidrId=vpcnatip-gw8y7q3cpk3fggs87****
&NatIp=192.168.0.34
&Action=CreateNatIp
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateNatIpResponse>
    <NatIp>192.168.0.34</NatIp>
    <RequestId>E9AD97A0-5338-43F8-8A80-5E274CCBA11B</RequestId>
    <NatIpId>vpcnatip-gw8y7q3cpk3fggs8****</NatIpId>
</CreateNatIpResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NatIp" : "192.168.0.34",
  "RequestId" : "E9AD97A0-5338-43F8-8A80-5E274CCBA11B",
  "NatIpId" : "vpcnatip-gw8y7q3cpk3fggs8****"
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. 指定的RegionId不存在。

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