All Products
Search

This Product

    NAT Gateway:ModifyFullNatEntryAttribute

    Document Center

    NAT Gateway:ModifyFullNatEntryAttribute

    Last Updated:Mar 22, 2024

    Modifies a FULLNAT entry.

    Operation description

    • ModifyFullNatEntryAttribute is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListFullNatEntries operation to query the status of a FULLNAT entry.

      • Modifying: indicates that the system is modifying the FULLNAT entry. You can query the FULLNAT entry, but cannot perform other operations.
      • Available: indicates that the FULLNAT entry is modified.

    • You cannot repeatedly call the ModifyFullNatEntryAttribute operation to modify a FULLNAT entry within the specified period of time.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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 the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		5A2CFF0E-5718-45B5-9D4D-70B3FF3898
    FullNatTableIdstringYes

    The ID of the FULLNAT table to be modified.

    		fulltb-gw88z7hhlv43rmb26****
    FullNatEntryIdstringYes

    The ID of the FULLNAT entry to be modified.

    		fullnat-gw8fz23jezpbblf1j****
    NetworkInterfaceIdstringNo

    The ID of the elastic network interface (ENI) to be modified.

    		eni-gw8g131ef2dnbu3k****
    NatIpstringNo

    The NAT IP address to be modified.

    		192.168.XX.XX
    NatIpPortstringNo

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

    		80
    AccessIpstringNo

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

    		192.168.XX.XX
    AccessPortstringNo

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

    		80
    IpProtocolstringNo

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

    • TCP: TCP
    • UDP
    		TCP
    FullNatEntryNamestringNo

    The new 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://.

    		modify
    FullNatEntryDescriptionstringNo

    The new description of the FULLNAT entry.

    You can leave this parameter empty or enter a description. If you enter a description, the description must be 2 to 256 characters in length and cannot start with http:// or https://.

    		abcd
    DryRunbooleanNo

    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false: performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		false
    RegionIdstringYes

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

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

    		eu-central-1

    Response parameters

    ParameterTypeDescriptionExample
    object

    The request ID.

    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "2315DEB7-5E92-423A-91F7-4C1EC9AD97C3"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ResourceNotFound.NetworkInterfaceIdThe specified resource is not found.The specified resource is not found.
    400ResourceAlreadyExist.FullNatEntryThe specified resource of %s is already exist.The FULLNAT rule already exists.
    400IncorrectStatus.NatIpThe status of %s [%s] is incorrect.The status of NatIp is incorrect.
    400UnsupportedFeature.PrivateLinkModeThe feature of %s is not supported.The feature of reverse access is not supported.
    400DependencyViolation.PrivateLinkModeThe specified resource of %s depends on %s, so the operation cannot be completed.The %s resource depends on %s.

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

    Change history

    Change timeSummary of changesOperation
    No change history