DescribeForwardTableEntries - Elastic Compute Service - Alibaba Cloud Documentation Center

DescribeForwardTableEntries

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribeForwardTableEntries for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

vpc:DescribeForwardTableEntries

get

*ForwardTable

acs:vpc:{#regionId}:{#accountId}:forwardtable/{#ForwardTableId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region that contains the DNAT table. Call the DescribeRegions operation to get the latest list of regions.
ForwardTableId	string	Yes	The ID of the DNAT table.
ForwardEntryId	string	No	The ID of the DNAT entry.
PageNumber	integer	No	The page number. Default value: 1.
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.

Response elements

Element	Type	Description	Example
	object	The response object.
PageSize	integer	The number of entries per page.
RequestId	string	The request ID.
PageNumber	integer	The page number.
TotalCount	integer	The total number of entries.
ForwardTableEntries	object	The collection of DNAT entries.
ForwardTableEntry	array<object>	The list of DNAT entries.
	object	The details of the DNAT entry.
Status	string	The status of the DNAT entry. Valid values: `Pending`, `Available`, and `Deleting`.
ForwardEntryId	string	The ID of the DNAT entry.
InternalIp	string	The private IP address of the ECS instance that uses the DNAT entry.
InternalPort	string	The private port of the ECS instance that is used for communication.
ForwardTableId	string	The ID of the DNAT table.
ExternalPort	string	The public port that is used for communication.
IpProtocol	string	The protocol. Valid values: `TCP`, `UDP`, and `Any`.
ExternalIp	string	The public IP address that is used for communication.

Examples

Success response

JSON format

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "ForwardTableEntries": {
    "ForwardTableEntry": [
      {
        "Status": "",
        "ForwardEntryId": "",
        "InternalIp": "",
        "InternalPort": "",
        "ForwardTableId": "",
        "ExternalPort": "",
        "IpProtocol": "",
        "ExternalIp": ""
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorretForwardEntryStatus	Some Forward entry status blocked this operation..	The DNAT entry is in a state that does not support the current operation.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified RegionId parameter does not exist. Check whether the service is available in the specified region.
404	InvalidForwardTableId.NotFound	Specified forwardTableId does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.