Creates a NAT IP address.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateNatIp

The operation that you want to perform. Set the value to CreateNatIp.

RegionId String Yes eu-central-1

The region ID of the NAT gateway to which the NAT IP address that you want to create belongs.

You can call the DescribeRegions operation to query the most recent region list.

NatIpName String Yes newnatip

The name of the NAT IP address.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter. It cannot start with http:// or https://.

NatIpDescription String Yes test

The description of the NAT IP address.

The description must be 2 to 256 characters in length. It must start with a letter or Chinese character but cannot start with http:// or https://.

NatGatewayId String Yes ngw-gw8v16wgvtq26vh59****

The ID of the Virtual Private Cloud (VPC) NAT gateway for which you want to create the NAT IP address.

DryRun Boolean No false

Specifies whether to precheck this request. Valid values:

  • true: sends the precheck request. The NAT IP address is not created. The system checks whether your AccessKey pair is valid, whether the RAM user is authorized, and whether the required parameters are set. If the request fails the precheck, the corresponding error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false (default): sends the request. If the request passes the precheck, a 2xx HTTP status code is returned and the NAT IP address is created.
ClientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

The client token that is used to ensure the idempotency. You can use the client to generate the value, but you must make sure that it is unique among different requests. The ClientToken can contain only ASCII characters. It cannot exceed 64 characters in length.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The ID of each request may be unique.
NatIpCidr String No 192.168.0.0/24

The CIDR block to which the NAT IP address belongs.

NatIpCidrId String No vpcnatip-gw8y7q3cpk3fggs87****

The ID of the CIDR block to which the NAT IP address belongs.

NatIp String No 192.168.0.34

The NAT IP address that you want to create.

If you do not specify an IP address, the system selects a random IP address from the specified CIDR block.

Response parameters

Parameter Type Example Description
NatIp String 192.168.0.34

The NAT IP address that is created.

NatIpId String vpcnatip-gw8y7q3cpk3fggs8****

The ID of the NAT IP address.

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateNatIp
&RegionId=eu-central-1
&NatIpName=newnatip
&NatIpDescription=test
&NatGatewayId=ngw-gw8v16wgvtq26vh59****
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

HttpCode Error code Error message Description
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. The error message returned because the specified region ID does not exist.

For a list of error codes, visit the API Error Center.