All Products
Search

This Product

    NAT Gateway:CreateFullNatEntry

    Document Center

    NAT Gateway:CreateFullNatEntry

    Last Updated:Aug 28, 2026

    Adds a FULLNAT entry to a FULLNAT table.

    Operation description

    • CreateFullNatEntry is an asynchronous operation. After a request is sent, the system returns a FULLNAT entry while the entry is still being added in the backend. You can call the ListFullNatEntries operation to query the status of the FULLNAT entry:

      • If the FULLNAT entry is in the Creating state, the entry is being added. In this state, you can only query the entry but cannot perform other operations.

      • If the FULLNAT entry is in the Available state, the entry is added.

    • Do not repeatedly call the CreateFullNatEntry operation for the same VPN gateway within the specified period of time.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ClientToken

    string

    No

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token value. Make sure that each request has a unique token value. The client token can contain only ASCII characters.

    Note

    If you do not specify this parameter, the system automatically uses the value of RequestId as the value of ClientToken. The request ID may be different for each request.

    5A2CFF0E-5718-45B5-9D4D-70B3FF3898
    FullNatTableId

    string

    Yes

    The ID of the FULLNAT table to which the FULLNAT entry belongs.

    fulltb-gw88z7hhlv43rmb26****
    NetworkInterfaceId

    string

    Yes

    The elastic network interface (ENI) ID.

    eni-gw8g131ef2dnbu3k****
    NatIp

    string

    Yes

    The NAT IP address that provides address translation.

    192.168.XX.XX
    NatIpPort

    string

    No

    The frontend port for FULLNAT port mapping. Valid values: 1 to 65535.

    80
    AccessIp

    string

    No

    The backend IP address for FULLNAT address translation.

    192.168.XX.XX
    AccessPort

    string

    Yes

    The backend port for FULLNAT port mapping. Valid values: 1 to 65535.

    80
    IpProtocol

    string

    Yes

    The protocol of the packets that are forwarded by the port. Valid values:

    • TCP

    • UDP

    TCP
    FullNatEntryName

    string

    No

    The name of the FULLNAT entry. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://.

    test
    FullNatEntryDescription

    string

    No

    The description of the FULLNAT entry.

    The description must be 2 to 256 characters in length and cannot start with http:// or https://.

    abc
    DryRun

    boolean

    No

    Specifies whether to perform a dry run. Valid values:

    • true: performs a dry run without adding the FULLNAT entry. The system checks whether your AccessKey pair is valid, whether RAM users are granted required permissions, and whether the required parameters are set. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.

    • false (default): sends the request. After the request passes the dry run, a 2XX HTTP status code is returned and the FULLNAT entry is added.

    false
    RegionId

    string

    Yes

    The region ID of the VPC NAT gateway to which the FULLNAT entry belongs.

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

    eu-central-1
    AccessDomain

    string

    No

    The backend domain name for FULLNAT address translation.

    xxx.com

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

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

    string

    The FULLNAT entry ID.

    fullnat-gw8fz23jezpbblf1j****

    Examples

    Success response

    JSON format

    {
  "RequestId": "2315DEB7-5E92-423A-91F7-4C1EC9AD97C3",
  "FullNatEntryId": "fullnat-gw8fz23jezpbblf1j****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ResourceNotFound.NatIp The specified resource of %s is not found. The specified NatIp parameter is not found.
    400 IllegalParamFormat.NatIp The param format of %s[%s] is illegal. The parameter format of NatIp is invalid.
    400 UnsupportedFeature.PrivateLinkMode The feature of %s is not supported. The feature of reverse access is not supported.
    400 QuotaExceeded.FullNatEntry The quota of %s is exceeded, usage %s/%s. The quota of FullNatEntry has been reached.
    400 IncorrectStatus.NatIp The status of %s [%s] is incorrect. The status of NatIp is incorrect.
    400 ResourceAlreadyExist.FullNatEntry The specified resource of %s is already exist. The FULLNAT rule already exists.
    400 IncorrectStatus.NetworkInterface The status of network interface is incorrect. The status of the ENI is invalid.
    400 OperationFailed.AllocateNatIpPortFailed NatIpPort allocation failed. NatIpPort allocation failed.
    400 IllegalParam.NetworkInterfaceId The param of NetworkInterfaceId is illegal. Invalid NetworkInterfaceId value.
    400 IllegalParam.AccessDomain The request parameter AccessDomain is illegal. The AccessDomain parameter in the request parameter is invalid.
    400 ExclusiveParam.AccessIpAndAccessDomain The specified AccessIp and AccessDomain are mutually exclusive. The specified input AccessIp conflicts with the AccessDomain.
    400 InstanceUnsupported.FullNatDomain The current instance does not support the configuration of the FullNat rule domain name. The current instance does not support the configuration of the FullNat rule domain name.
    400 ZoneUnsupported.FullNatDomain The current zone does not support the configuration of the FullNat rule domain name. The current zone does not support the configuration of the FullNat rule domain name.
    500 InternalError The request processing has failed due to some unknown error, exception or failure. An internal error occurred.
    404 ResourceNotFound.NatGateway The NatGateway instance not exist. The NAT gateway does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.