All Products
Search

This Product

    Virtual Private Cloud:CreateFullNatEntry

    Document Center

    Virtual Private Cloud:CreateFullNatEntry

    Last Updated:Nov 13, 2024

    Adds a FULLNAT entry to the FULLNAT table.

    Operation description

    • CreateFullNatEntry is an asynchronous operation. After you send a request to call this operation, the system returns a FULLNAT entry and the FULLNAT entry is being added in the backend. You can call the ListFullNatEntries operation to query the status of a FULLNAT entry.

      • If the FULLNAT entry is in the Creating state, the system is adding the FULLNAT entry. You can only query the status of the FULLNAT entry, but cannot perform other operations.
      • If the FULLNAT entry is in the Available state, the FULLNAT entry is added.

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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

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

    You can use the client to generate a value, and you must 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
    FullNatTableIdstringYes

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

    		fulltb-gw88z7hhlv43rmb26****
    NetworkInterfaceIdstringYes

    The elastic network interface (ENI) ID.

    		eni-gw8g131ef2dnbu3k****
    NatIpstringYes

    The NAT IP address that provides address translation.

    		192.168.XX.XX
    NatIpPortstringYes

    The frontend port to be modified in the mapping of FULLNAT port. Valid values: 1 to 65535.

    		80
    AccessIpstringYes

    The backend IP address to be modified in FULLNAT address translation.

    		192.168.XX.XX
    AccessPortstringYes

    The backend port to be modified in the mapping of FULLNAT port. Valid values: 1 to 65535.

    		80
    IpProtocolstringYes

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

    • TCP
    • UDP
    		TCP
    FullNatEntryNamestringNo

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

    		test
    FullNatEntryDescriptionstringNo

    The description of the FULLNAT entry.

    This parameter is optional. If you enter a description, the description must be 2 to 256 characters in length, and cannot start with http:// or https://.

    		abc
    DryRunbooleanNo

    Specifies whether to only precheck this request. Valid values:

    • true: prechecks the request 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 to pass the precheck, an error code is returned. If the request passes the precheck, the DryRunOperation error code is returned.
    • false: sends the API request. This is the default value. After the request passes the precheck, a 2XX HTTP status code is returned and the FULLNAT entry is added.
    		false
    RegionIdstringYes

    The region ID of the Virtual Private Cloud (VPC) NAT gateway to which the FULLNAT entry to be added belongs.

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

    		eu-central-1

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

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

    The FULLNAT entry ID.

    		fullnat-gw8fz23jezpbblf1j****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400ResourceNotFound.NatIpThe specified resource of %s is not found.The specified NatIp parameter is not found.
    400IllegalParamFormat.NatIpThe param format of %s[%s] is illegal.The parameter format of NatIp is invalid.
    400UnsupportedFeature.PrivateLinkModeThe feature of %s is not supported.The feature of reverse access is not supported.
    400QuotaExceeded.FullNatEntryThe quota of %s is exceeded, usage %s/%s.The quota of FullNatEntry has been reached.
    400IncorrectStatus.NatIpThe status of %s [%s] is incorrect.The status of NatIp is incorrect.
    400ResourceAlreadyExist.FullNatEntryThe specified resource of %s is already exist.The FULLNAT rule already exists.
    400IncorrectStatus.NetworkInterfaceThe status of network interface is incorrect.The status of the ENI is invalid.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-08-09The Error code has changedView Change Details
    2024-06-06The Error code has changedView Change Details
    2023-03-20The Error code has changedView Change Details