All Products
Search

This Product

    ENS:DescribeForwardEntryAttribute

    Document Center

    ENS:DescribeForwardEntryAttribute

    Last Updated:Apr 14, 2026

    Queries a DNAT rule.

    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:DescribeForwardEntryAttribute

    get

    *NatGatewayForwardEntry

    acs:ens::{#accountId}:natgatewayforwardentry/{#ForwardEntryId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ForwardEntryId

    string

    Yes

    The ID of the DNAT entry.

    fwd-5tfi6f0rutmd00xrhkag7****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response.

    RequestId

    string

    The request ID.

    6666C5A5-75ED-422E-A022-7121FA18C968
    NatGatewayId

    string

    The ID of the NAT Gateway.

    nat-5t7nh1cfm6kxiszlttr38****
    ForwardEntryId

    string

    The ID of the DNAT entry.

    fwd-5tfi6f0rutmd00xrhkag7****
    ExternalIp

    string

    The Elastic IP Address (EIP) that provides public network access in the DNAT entry.

    36.XXX.XXX.72
    InternalIp

    string

    The private IP address of the instance that communicates over the public network through the DNAT entry.

    10.XXX.XXX.50
    ForwardEntryName

    string

    The name of the DNAT entry.

    test0
    Status

    string

    The status of the DNAT entry.

    • Pending: The configuration is in progress, such as during creation or modification.

    • Available: The entry is active.

    • Deleting: The entry is being deleted.

    Available
    CreationTime

    string

    The creation time in UTC.

    2020-04-26T15:38:27Z
    ExternalPort

    string

    The external port or port range for port forwarding.

    • The port range must be between 1 and 65535.

    • To forward a port range, separate the start and end ports with a forward slash (/), such as 10/20.

    22
    InternalPort

    string

    The internal port or port range for port forwarding.

    • The port range must be between 1 and 65535.

    • To forward a port range, separate the start and end ports with a forward slash (/), such as 10/20.

    22
    IpProtocol

    string

    The protocol type. Valid values:

    • TCP: Forwards TCP messages.

    • UDP: Forwards UDP messages.

    • Any: Forwards messages of all protocols.

    Any
    HealthCheckPort

    string

    The probe port for DNAT. It must fall within the internal port range. The default value is empty.

    80
    StandbyExternalIp

    string

    The standby Elastic IP Address (EIP) that provides public network access. You must select a standby EIP attached to the NAT Gateway. The standby public IP becomes active after the DNAT entry is created.

    101.XXX.XXX.4
    StandbyStatus

    string

    The status of the standby EIP.

    • Running: Enabled.

    • Stopping: Being disabled.

    • Stopped: Disabled.

    • Starting: Being enabled.

    Stopped

    Examples

    Success response

    JSON format

    {
  "RequestId": "6666C5A5-75ED-422E-A022-7121FA18C968",
  "NatGatewayId": "nat-5t7nh1cfm6kxiszlttr38****",
  "ForwardEntryId": "fwd-5tfi6f0rutmd00xrhkag7****",
  "ExternalIp": "36.XXX.XXX.72",
  "InternalIp": "10.XXX.XXX.50",
  "ForwardEntryName": "test0",
  "Status": "Available",
  "CreationTime": "2020-04-26T15:38:27Z",
  "ExternalPort": "22",
  "InternalPort": "22",
  "IpProtocol": "Any",
  "HealthCheckPort": "80",
  "StandbyExternalIp": "101.XXX.XXX.4",
  "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 InvalidForwardEntryId.NotFound The specified forwardEntry is not found. The specified DNAT does not exist. Check whether the input parameters are correct.
    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.