CreateForwardEntry - Elastic Compute Service - Alibaba Cloud Documentation Center

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - CreateForwardEntry 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:CreateForwardEntry

create

*ForwardTable

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the DNAT table is located. You can call the DescribeRegions operation to retrieve a list of available regions.
ForwardTableId	string	Yes	The ID of the DNAT table.
ExternalIp	string	Yes	The public IP address for the DNAT entry. This must be a public IP address of the NAT gateway associated with the DNAT table.
ExternalPort	string	Yes	The external port used for DNAT. Valid values: 1 to 65535.
InternalIp	string	Yes	The private IP address to which traffic is forwarded.
InternalPort	string	Yes	The internal port to which traffic is forwarded. Valid values: 1 to 65535.
IpProtocol	string	Yes	The protocol. Valid values: TCP, UDP, and Any. If you set this parameter to Any, the DNAT entry applies to all protocols.

Response elements

Element	Type	Description	Example
	object	The response data.
ForwardEntryId	string	The ID of the forwarding entry.
RequestId	string	The request ID.

Examples

Success response

JSON format

{
  "ForwardEntryId": "",
  "RequestId": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationUnsupported.ForwardEntry	Duplicated destination ip port is unsupported.
400	InvalidExternalIp.Malformed	The specified ExternalIp is not a valid IP address.	The specified public IP address is invalid.
400	InvalidInternalIp.Malformed	The specified InternalIp is not a valid IP address.	The specified internal IP address is invalid.
400	InvalidExternalPort.Malformed	The specified ExternalPort is not a valid port.
400	InvalidInternalPort.Malformed	The specified InternalPort is not a valid port.	The specified InternalPort parameter is invalid.
400	Forbidden.DestnationIpOutOfVpcCIDR	The specified Internal Ip is Out of VPC CIDR.
400	InvalidProtocal.ValueNotSupported	The specified IpProtocol does not support.	The specified IpProtocol parameter is invalid.
400	IncorretForwardEntryStatus	Some Forward entry status blocked this operation..	The DNAT entry is in a state that does not support the current operation.
400	QuotaExceeded	Forward entry quota exceeded in this route table.	The maximum number of the forward entry is exceeded.
400	ForwardEntry.Duplicated	The specified ExternalIp, IpProtocol, ExternalPort,InternalIp, InternalPort is duplicated.
400	Invalid.natgwNotExist	The specified natgateway not exist.
400	InvalidIp.NotInNatgw	The specified ip not belong to natgateway.
400	MissingParameter	Missing mandatory parameter.	Required parameters must be specified.
400	OperationFailed.InstacneBindEip	Private ip instance already bind eip.
400	DuplicatedParam.ExternalPort	The param of %s is duplicated.
400	DuplicatedParam.InternalPort	The param of %s is duplicated.
400	UnsupportedFeature.PrivateLinkEnabled	The feature of PrivateLinkEnabled is not supported.
400	UnsupportedFeature.PortSegment	The feature of PortSegment is not supported.
400	ExclusiveParam.%sAnd%s	The param of %s and %s are mutually exclusive.
400	OperationFailed.AnyPortConfig	Operation failed because any port correspondence any protocol.
400	QuotaExceeded.ForwardEntry	The quota of %s is exceeded, usage %s/%s.
400	IncorrectStatus.NatIp	The status of %s [%s] is incorrect.
400	Forbidden.IpHasBeenUsedInSnat	The source ip can't be used. Because it has been used in snat.
400	Forbidden.DestinationIpOutOfVswitchCIDR	The specified Internal Ip is Out of VSwitch CIDR.
400	Forbidden.ExternalIp.UsedInSnatTable	The specified ExternalIp is already used in SnatTable.
400	Forbidden.InternalIpOutOfVpcCIDR	The specified Internal Ip is Out of VPC CIDR.
400	AnyPort.PortMustBeZero	Any port port must be zero.
400	InvalidParameter.Name.Malformed	The specified Name is not valid.
400	IncorrectStatus.ForwardEntry	The status of %s [%s] is incorrect.
400	Duplicated.DestinationPort	The specified param DestinationPort is duplicated.
400	OperationUnsupported.EipInBinding	Create snat entry with eip in associating status is unsupported.
400	QuotaExceeded.ForwardEntrySessionManytoOne	The dnat session quota is exceed.
400	DuplicatedParam.%s	The param of %s is duplicated.
400	UnsupportedFeature.%s	The feature of %s is not supported.
400	Operation.Conflict	The operation may conflicts with others.	The operation conflicts with other operations.
500	InternalError	The request processing has failed due to some unknown error.
500	System.Error	ERROR SYSTEM ERROR.
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 forward table does not exist.
404	InvalidExternalIp.NotFound	Specified External Ip address does not found on the VRouter.
404	ResourceNotFound.NatIp	The specified resource of %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.