All Products
Search

This Product

    ENS:DescribeForwardEntryAttribute

    Document Center

    ENS:DescribeForwardEntryAttribute

    Last Updated:Dec 10, 2025

    You can call the DescribeForwardEntryAttribute operation to query the details of a DNAT rule.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ens:DescribeForwardEntryAttributeget
    *NatGatewayForwardEntry
    acs:ens::{#accountId}:natgatewayforwardentry/{#ForwardEntryId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ForwardEntryIdstringYes

    The ID of the DNAT entry.

    		fwd-5tfi6f0rutmd00xrhkag7****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response data.

    RequestIdstring

    The request ID.

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

    The ID of the NAT gateway.

    		nat-5t7nh1cfm6kxiszlttr38****
    ForwardEntryIdstring

    The ID of the DNAT entry.

    		fwd-5tfi6f0rutmd00xrhkag7****
    ExternalIpstring

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

    		36.XXX.XXX.72
    InternalIpstring

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

    		10.XXX.XXX.50
    ForwardEntryNamestring

    The name of the DNAT entry.

    		test0
    Statusstring

    The status of the DNAT entry.

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

    The creation time. The time is displayed in UTC.

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

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

    • Valid values: 1 to 65535.
    • To specify a port range, separate the first port and the last port with a forward slash (/), such as 10/20.
    		22
    InternalPortstring

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

    • Valid values: 1 to 65535.
    • To specify a port range, separate the first port and the last port with a forward slash (/), such as 10/20.
    		22
    IpProtocolstring

    The protocol. Valid values:

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

    The DNAT probe port. The port must be within the internal port range. By default, this parameter is empty.

    		80
    StandbyExternalIpstring

    The secondary EIP that is used to access the Internet. You need to select a secondary EIP that is bound to NAT. After the DNAT entry is created, the secondary EIP takes effect.

    		101.XXX.XXX.4
    StandbyStatusstring

    The status of the secondary EIP.

    • Running
    • Stopping
    • Stopped
    • Starting
    		Stopped

    Examples

    Sample success responses

    JSONformat

    {
  "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 codeError codeError messageDescription
    400Invalid%sThe specified parameter %s is invalid.-
    400Missing%sYou must specify the parameter %s.-
    400InvalidForwardEntryId.NotFoundThe specified forwardEntry is not found.The specified DNAT does not exist. Check whether the input parameters are correct.
    400ens.interface.errorFailed to call API.-
    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
    2025-11-25Add OperationView Change Details