All Products
Search

This Product

    NAT Gateway:ListFullNatEntries

    Document Center

    NAT Gateway:ListFullNatEntries

    Last Updated:Nov 14, 2024

    Queries FULLNAT entries.

    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

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:ListFullNatEntriesget
    • FullNat
      acs:vpc:{#regionId}:{#accountId}:vpcfullnattable/{#FullNatTableId}
      none
    		none

    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 client 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
    FullNatTableIdstringNo

    The ID of the FULLNAT table to which the FULLNAT entries to be queried belong.

    Note You must specify at least one of FullNatTableId and NatGatewayId.
    		fulltb-gw88z7hhlv43rmb26****
    FullNatEntryIdstringNo

    The ID of the FULLNAT entry that you want to query.

    		fullnat-gw8fz23jezpbblf1j****
    FullNatEntryNamesarrayNo

    The name of the FULLNAT entry that you want to query. You can specify at most 20 names.

    The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

    stringNo

    The name of the FULLNAT entry that you want to query. You can specify at most 20 names.

    The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

    		test
    NetworkInterfaceIdsarrayNo

    The ID of the elastic network interface (ENI) that you want to query.

    stringNo

    The ID of the ENI that you want to query. You can specify up to 20 ENIs.

    		eni-gw80wedm8pq0tpr2****
    NextTokenstringNo

    The pagination token that is used in the next request to retrieve a new page of results. Valid values:

    • You do not need to specify this parameter for the first request.
    • You must specify the token that is obtained from the previous query as the value of the NextToken parameter.
    		caeba0bbb2be03f84eb48b699f0a4883
    MaxResultslongNo

    The number of entries per page. Valid values: 1 to 100. Default value: 20.

    		20
    RegionIdstringYes

    The region ID of the virtual private cloud (VPC) NAT gateway to which the FULLNAT entries to be queried belong.

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

    		eu-central-1
    IpProtocolstringNo

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

    • TCP
    • UDP
    		TCP
    NatGatewayIdstringNo

    The ID of the NAT gateway.

    Note You must specify at least one of FullNatTableId and NatGatewayId.
    		ngw-bp1uewa15k4iy5770****
    NatIpstringNo

    The NAT IP address that provides address translation in FULLNAT entries.

    		10.0.XX.XX
    NatIpPortstringNo

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

    		443

    Response parameters

    ParameterTypeDescriptionExample
    object

    The request ID.

    RequestIdstring

    The request ID.

    		F03E41F6-1A74-311F-8D98-124EEE9F37B8
    NatGatewayIdstring

    The ID of the VPC NAT gateway.

    		ngw-gw8054kn57y3hq3bv****
    FullNatTableIdstring

    The ID of the FULLNAT table to which the queried FULLNAT entries belong.

    		fullnat-gw8fz23jezpbblf1j****
    TotalCountlong

    The number of FULLNAT entries returned.

    		1
    NextTokenstring

    Indicates whether the token for the next query exists. Valid values:

    • If the value of NextToken is empty, no next queries are sent.
    • If the value of NextToken is returned, the value indicates the token that is used for the next query.
    		caeba0bbb2be03f84eb48b699f0a4883
    MaxResultslong

    The maximum number of entries returned.

    		1
    FullNatEntriesarray<object>

    The information about the FULLNAT entries that are queried.

    FullNatEntryobject
    NatIpstring

    The NAT IP address that is used for address translation in FULLNAT entries.

    		192.168.XX.XX
    NatIpPortstring

    The frontend port that is used for port mapping in FULLNAT entries. Valid values: 1 to 65535.

    		80
    AccessIpstring

    The backend IP address that is used for FULLNAT address translation in FULLNAT entries.

    		192.168.XX.XX
    AccessPortstring

    The backend port that is used for port mapping in FULLNAT entries. Valid values: 1 to 65535.

    		80
    IpProtocolstring

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

    • TCP
    • UDP
    		TCP
    NetworkInterfaceIdstring

    The ID of the elastic network interface (ENI).

    		eni-gw80wedm8pq0tpr2****
    NetworkInterfaceTypestring

    The type of the ENI. The value is set to Endpoint, which indicates a reverse endpoint.

    		Endpoint
    FullNatEntryNamestring

    The name of the FULLNAT entry.

    The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

    		test
    FullNatEntryDescriptionstring

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

    		abc
    CreationTimestring

    The time when the FULLNAT entry was created.

    		2021-10-27T02:44:40Z
    FullNatEntryIdstring

    The ID of the FULLNAT entry.

    		fullnat-gw8fz23jezpbblf1j****
    FullNatEntryStatusstring

    The status of the FULLNAT entry. Valid values:

    • Pending
    • Available
    • Deleting
    • Deleted
    		Available
    FullNatTableIdstring

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

    		fulltb-gw88z7hhlv43rmb26****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "F03E41F6-1A74-311F-8D98-124EEE9F37B8",
  "NatGatewayId": "ngw-gw8054kn57y3hq3bv****",
  "FullNatTableId": "fullnat-gw8fz23jezpbblf1j****",
  "TotalCount": 1,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "MaxResults": 1,
  "FullNatEntries": [
    {
      "NatIp": "192.168.XX.XX",
      "NatIpPort": "80",
      "AccessIp": "192.168.XX.XX",
      "AccessPort": "80",
      "IpProtocol": "TCP",
      "NetworkInterfaceId": "eni-gw80wedm8pq0tpr2****",
      "NetworkInterfaceType": "Endpoint",
      "FullNatEntryName": "test",
      "FullNatEntryDescription": "abc",
      "CreationTime": "2021-10-27T02:44:40Z",
      "FullNatEntryId": "fullnat-gw8fz23jezpbblf1j****",
      "FullNatEntryStatus": "Available",
      "FullNatTableId": "fulltb-gw88z7hhlv43rmb26****"
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ResourceNotFound.FullNatTableIdThe specified resource of %s is not found.-
    400MissingParam.FullnatTableIdOrNatGatewayIdFullnatTableId and natGatewayId can not both be nullFullnatTableId and natGatewayId cannot be empty at the same time.
    400ResourceNotFound.FullNatTableThe NAT gateway has no full nat table.No FULLNAT table is configured for the NAT gateway.

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

    Change history

    Change timeSummary of changesOperation
    2023-12-20The Error code has changed. The request parameters of the API has changedView Change Details