Use CreateForwardEntry to add a DNAT entry - ENS - Alibaba Cloud - ENS

Adds a DNAT entry by calling CreateForwardEntry.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NatGatewayId	string	Yes	The ID of the NAT gateway.	nat-5t7nh1cfm6kxiszlttr38****
ExternalIp	string	Yes	The Elastic IP Address (EIP) that provides public network access. The EIP must not be occupied by an SNAT rule of the same NAT gateway. You can check the IpLists.UsingStatus field returned by DescribeNatGateways to confirm that the EIP is in the Idle state.	121.XXX.XXX.28
ExternalPort	string	Yes	The external port or port range for port forwarding. The port range must be within 1 to 65535. To forward traffic within a port range, separate the start and end ports with a forward slash (/), such as 10/20. If ExternalPort is set to a port range, InternalPort must also be set to a port range with the same number of ports. For example, if ExternalPort is set to 10/20, InternalPort must be set to 80/90.	22
InternalIp	string	Yes	The private IP address of the instance that communicates with the Internet through the DNAT entry.	10.0.XXX.XXX
InternalPort	string	Yes	The internal port or port range for port forwarding. The port range must be within 1 to 65535. To forward traffic within a port range, separate the start and end ports with a forward slash (/), such as 10/20.	22
ForwardEntryName	string	No	The name of the DNAT rule. The name must be 2 to 128 characters in length and cannot start with `http://` or `https://`.	test0
IpProtocol	string	No	The protocol type. Valid values: TCP: forwards TCP packets. UDP: forwards UDP packets. Any (default): forwards all packets. Valid values: TCP : TCP protocol. UDP : UDP protocol. Any : all protocols.	Any
HealthCheckPort	integer	No	The health check port for DNAT. The port must be within the internal port range. Default value: empty.	80
StandbyExternalIp	string	No	The standby EIP that provides public network access. The standby EIP must be bound to the NAT gateway. After the DNAT entry is created, the standby EIP takes effect.	101.XXX.XXX.4

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	EF6D6FA4-DACA-5822-A981-81006271D263
ForwardEntryId	string	The ID of the DNAT entry.	fwd-5tc07cw14metghn3siv4a****

Examples

Success response

JSON format

{
  "RequestId": "EF6D6FA4-DACA-5822-A981-81006271D263",
  "ForwardEntryId": "fwd-5tc07cw14metghn3siv4a****"
}

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	InvalidParameter.ExternalIp	The specified externalIp is not found.
400	Forbidden.ExternalIpUsedInSnat	Forbidden.ExternalIpUsedInSnat
400	InvalidParameter.InternalIpNotFound	The input parameter internalIp that is not found.
400	Forbidden.ExternalPort.Duplicated	The specified ExternalPort is duplicated.	A DNAT rule has been configured for the external port. Do not repeat the configuration.
400	ForwardEntryLimitExceed	The limit of forward entry in the nat reaches.
400	InvalidParameter.HealthCheckPort	HealthCheckPort is not in the range of InternalPort
400	IncorrectInstanceStatus	The current status of the instance does not support this operation.	The instance is in a state that does not support the current operation.
400	SystemBusy	System is busy, please try again later.	The system is currently busy, please try again later.
400	InvalidParameter.InternalIp	The specified parameter internalIp is invalid.	The parameter internal IP is incorrect.
400	InvalidPort.Malformed	The specified port is not a valid port.	The specified port is incorrect
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.