Query DNAT entries using DescribeForwardTableEntries - ENS

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeForwardTableEntries

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NatGatewayId	string	Yes	The ID of the NAT gateway.	nat-5t7nh1cfm6kxiszlttr38****
ForwardEntryId	string	No	The ID of the DNAT entry.	fwd-5tfi6f0rutmd00xrhkag7****
ExternalIp	string	No	The EIP in the DNAT entry. The public IP address is used to access the Internet.	36.XXX.XXX.72
InternalIp	string	No	The private IP address of the instance that uses the DNAT entry for Internet communication.	10.XXX.XXX.50
ForwardEntryName	string	No	The name of the DNAT entry.	test0
IpProtocol	string	No	The protocol. Valid values: TCP: forwards TCP packets. UDP: forwards UDP packets. Any: forwards all packets.	TCP
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	string	The page number.	1
TotalCount	string	The total number of entries returned.	100
PageSize	string	The number of entries per page.	10
ForwardTableEntries	array<object>	Details of DNAT entries.
	object
NatGatewayId	string	The ID of the NAT gateway.	nat-5tawjw5j7sgd2deujxuk0****
ForwardEntryId	string	The ID of the DNAT entry.	fwd-5tf66679oi2uoxcvlg0g2****
ExternalIp	string	The EIP in the DNAT entry. The public IP address is used to access the Internet.	120.XXX.XXX.70
ExternalPort	string	The external port or port range that is used in port forwarding.	22
InternalIp	string	The private IP address of the instance that uses the DNAT entry for Internet communication.	10.XXX.XXX.3
InternalPort	string	The internal port or port range that is used for port forwarding.	22
ForwardEntryName	string	The name of the DNAT entry.	test0
Status	string	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
IpProtocol	string	The protocol. Valid values: TCP: forwards TCP packets. UDP: forwards UDP packets. Any: forwards all packets.	Any
HealthCheckPort	string	The probe port of DNAT.	80
StandbyExternalIp	string	The secondary EIP that is used to access the Internet.	101.XXX.XXX.7
StandbyStatus	string	The status of the secondary EIP. Valid values: Running Stopping Stopped Starting	Stopped

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	InvalidParameter.NatNotFound	The specified Nat is not found.	The specified parameter Nat does not exist.
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.