Queries one or more DNAT entries in a DNAT table.

Make the API call

You can use OpenAPI Explorer to make API calls, search for API calls, perform debugging, and generate SDK example code.

Request parameters

Parameter Type Required? Example value Description
Action String Yes DescribeForwardTableEntries

The name of this action.DescribeForwardTableEntries
ForwardTableId String Yes ftb-bp1mbjubq34hlcqpa****

The ID of the DNAT table.

RegionId String Yes cn-hangzhou

The ID of the region to which the NAT Gateway belongs. To query the region ID, call DescribeRegions.

ForwardEntryId String No fwd-8vbn3bc8roygjp0gy****

The ID of the DNAT entry allocated by the system.
ExternalIp String No 116.xx.xx.28

The public IP address.
ExternalPort String No 8080

The public port number. Value range: 1 to 65535
InternalIp String No 192.168.xx.xx

The destination private IP address.
InternalPort String No 80

The destination private port number. Value range: 1 to 65535
IpProtocol String No TCP

The protocol type. Valid values:

  • TCP: Forward TCP packets.
  • UDP: Forward UDP packets.
  • Any: Forward all packets.
ForwardEntryName String No ForwardEntry-1

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

PageNumber Integer No 1

The page number. Default value: 1

PageSize Integer No 10

Optional. The number of entries per page in the case of a paged query result. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example value Description
RequestId String A6C4A8B1-7561-4509-949C-20DEB40D71E6

The ID of the request..
TotalCount Integer 5

The number of total entries.
PageNumber Integer 1

The current page number.
PageSize Integer 10

The number of entries per page.
ForwardTableEntries Array

The details of DNAT entries.
ForwardTableId String ftb-11tc6xgmv****

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

ForwardEntryId String fwd-119smw5tk****

The ID of the DNAT entry.

ExternalIp String 139.xxx.xx.79

The public IP address.

ExternalPort String 80

The public port.

IpProtocol String TCP

The protocol type.

InternalIp String 192.168.1.xx

The private IP address.

InternalPort String 25

The destination private port number. Value range: 1 to 65535
Status String Available

The status of the DNAT entry.
ForwardEntryName String ForwardEntry-1

The name of the DNAT rule.

Examples

Request example

https://vpc.aliyuncs.com/?Action=DescribeForwardTableEntries
&ForwardTableId=ftb-bp1mbjubq34hlcqpa****
&RegionId=cn-hangzhou
&<CommonParameters>

Response example

XML format 

<DescribeForwardTableEntriesResponse>	
  <PageNumber>1</PageNumber>
  <TotalCount>1</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>D15864E1-6068-4CF9-AC3D-653D2143E269</RequestId>
  <ForwardTableEntries>
        <ForwardTableEntry>
              <Status>Available</Status>
              <IpProtocol>TCP</IpProtocol>
              <ForwardEntryId>fwd-bp1yjpsk36ojv9rrz****</ForwardEntryId>
              <ExternalIp>47.96.xx.184</ExternalIp>
              <ForwardTableId>ftb-bp1pnianh59fsh09b****</ForwardTableId>
              <ExternalPort>80</ExternalPort>
              <InternalPort>25</InternalPort>
              <InternalIp>192.168.xx.39</InternalIp>
              <ForwardEntryName>vmeixme</ForwardEntryName>
        </ForwardTableEntry>
  </ForwardTableEntries>
</DescribeForwardTableEntriesResponse>

JSON format 

{
	"PageNumber": 1,
	"TotalCount": 1,
	"PageSize": 10,
	"RequestId": "D15864E1-6068-4CF9-AC3D-653D2143E269",
	"ForwardTableEntries": {
		"ForwardTableEntry": [
			{
				"Status": "Available",
				"IpProtocol": "TCP",
				"ForwardEntryId": "fwd-bp1yjpsk36ojv9rrz****",
				"ExternalIp": "47.96.xx.184",
				"ForwardTableId": "ftb-bp1pnianh59fsh09b****",
				"ExternalPort": "80",
				"InternalPort": "25",
				"InternalIp": "192.168.xx.39",
				"ForwardEntryName": "vmeixme"
			}
		]
	}
}

Errors

HTTP status code Error code Error message Description
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. The specified RegionId does not exist.
400 IncorretForwardEntryStatus Some Forward entry status blocked this operation.. You cannot perform this operation because one or more DNAT entries in the DNAT table are in the Pending or Modifying state.
404 InvalidForwardTableId.NotFound Specified forwardTableId does not exist The specified DNAT table does not exist.

For a list of error codes, visit the API Error Center.