All Products
Search
Document Center

ENS:DescribeForwardTableEntries

Last Updated:Mar 12, 2024

Queries Destination Network Address Translation (DNAT) entries that you created.

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
NatGatewayIdstringYes

The ID of the NAT gateway.

nat-5t7nh1cfm6kxiszlttr38****
ForwardEntryIdstringNo

The ID of the DNAT entry.

fwd-5tfi6f0rutmd00xrhkag7****
ExternalIpstringNo

The EIP in the DNAT entry. The public IP address is used to access the Internet.

36.XXX.XXX.72
InternalIpstringNo

The private IP address of the instance that uses the DNAT entry for Internet communication.

10.XXX.XXX.50
ForwardEntryNamestringNo

The name of the DNAT entry.

test0
IpProtocolstringNo

The protocol. Valid values:

  • TCP: forwards TCP packets.
  • UDP: forwards UDP packets.
  • Any: forwards all packets.
TCP
PageNumberintegerNo

The page number. Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 100.

Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberstring

The page number.

1
TotalCountstring

The total number of entries returned.

100
PageSizestring

The number of entries per page.

10
ForwardTableEntriesobject []

Details of DNAT entries.

NatGatewayIdstring

The ID of the NAT gateway.

nat-5tawjw5j7sgd2deujxuk0****
ForwardEntryIdstring

The ID of the DNAT entry.

fwd-5tf66679oi2uoxcvlg0g2****
ExternalIpstring

The EIP in the DNAT entry. The public IP address is used to access the Internet.

120.XXX.XXX.70
ExternalPortstring

The external port or port range that is used in port forwarding.

22
InternalIpstring

The private IP address of the instance that uses the DNAT entry for Internet communication.

10.XXX.XXX.3
InternalPortstring

The internal port or port range that is used for port forwarding.

22
ForwardEntryNamestring

The name of the DNAT entry.

test0
Statusstring

The status of the DNAT entry. Valid values:

  • Pending: The DNAT entry is being created or modified.
  • Available: The DNAT entry is available.
  • Deleting: The DNAT entry is being deleted.
Available
IpProtocolstring

The protocol. Valid values:

  • TCP: forwards TCP packets.
  • UDP: forwards UDP packets.
  • Any: forwards all packets.
Any
HealthCheckPortstring

The probe port of DNAT.

80
StandbyExternalIpstring

The secondary EIP that is used to access the Internet.

101.XXX.XXX.7
StandbyStatusstring

The status of the secondary EIP. Valid values:

  • Running
  • Stopping
  • Stopped
  • Starting
Stopped

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": "1",
  "TotalCount": "100",
  "PageSize": "10",
  "ForwardTableEntries": [
    {
      "NatGatewayId": "nat-5tawjw5j7sgd2deujxuk0****",
      "ForwardEntryId": "fwd-5tf66679oi2uoxcvlg0g2****",
      "ExternalIp": "120.XXX.XXX.70",
      "ExternalPort": "22",
      "InternalIp": "10.XXX.XXX.3",
      "InternalPort": "22",
      "ForwardEntryName": "test0",
      "Status": "Available",
      "IpProtocol": "Any",
      "HealthCheckPort": "80",
      "StandbyExternalIp": "101.XXX.XXX.7",
      "StandbyStatus": "Stopped"
    }
  ]
}

Error codes

HTTP status codeError codeError message
400Invalid%sThe specified parameter %s is invalid.
400Missing%sYou must specify the parameter %s.
400ens.interface.error An error occurred while call the API.
400InvalidParameter.NatNotFoundThe specified Nat is not found.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

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

Change history

Change timeSummary of changesOperation
2023-12-07The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-07-18The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
Output ParametersThe response structure of the API has changed.