Adds a DNAT entry to a DNAT table.
Operation description
Each DNAT entry consists of the following parameters: ExternalIp, ExternalPort, IpProtocol, InternalIp, and InternalPort. After you add a DNAT entry, the NAT gateway forwards packets over the specified protocol from ExternalIp:ExternalPort to InternalIp:InternalPort and sends responses back through the same route.
When you call this operation, take note of the following limits:
-
CreateForwardEntry is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeForwardTableEntries operation to query the status of the task.
- If the DNAT entry is in the Pending state, the system is adding the DNAT entry. You can only query the DNAT entry, but cannot perform other operations.
- If the DNAT entry is in the Available state, the DNAT entry is added.
-
You cannot repeatedly call the CreateForwardEntry operation to add a DNAT entry within a specific period of time.
-
All combinations of ExternalIp, ExternalPort, and IpProtocol used in DNAT entries must be unique. You cannot distribute requests to more than one Elastic Compute Service (ECS) instance if these requests are initiated from the same source IP address, received on the same port, and use the same protocol.
-
The combinations of IpProtocol, InternalIp, and InternalPort must be unique.
-
If one or more DNAT entries in the DNAT table are in the Pending or Modifying state, you cannot add DNAT entries to the DNAT table.
-
You can add at most 100 DNAT entries to a DNAT table.
-
For an elastic IP address (EIP) used by an Internet NAT gateway or a NAT IP address used by a Virtual Private Cloud (VPC) NAT gateway, take note of the following limit: If the IP address has IP mapping enabled and is specified in a DNAT entry, the IP address cannot be used by another DNAT or SNAT entry.
Debugging
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vpc:CreateForwardEntry | create | *ForwardTable acs:vpc:{#regionId}:{#accountId}:forwardtable/{#ForwardTableId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the NAT gateway. You can call the DescribeRegions operation to obtain the region ID. | cn-hangzhou |
| ForwardTableId | string | Yes | The ID of the DNAT table. | ftb-bp1mbjubq34hlcqpa**** |
| ExternalIp | string | Yes |
| 116.28.XX.XX |
| ExternalPort | string | Yes |
| 8080 |
| InternalIp | string | Yes |
| 192.168.XX.XX |
| InternalPort | string | Yes |
| 80 |
| IpProtocol | string | Yes | The protocol. Valid values:
| TCP |
| ForwardEntryName | string | No | The name of the DNAT entry. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with | ForwardEntry-1 |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 0c593ea1-3bea-11e9-b96b-88e9fe6**** |
| PortBreak | boolean | No | Specifies whether to remove limits on the port range. Valid values:
Note
If a DNAT entry and an SNAT entry have the same public IP address, ou must specify a port that is larger that 1024, and set PortBreak to true.
| false |
Response parameters
Examples
Sample success responses
JSONformat
{
"ForwardEntryId": "fwd-119smw5tkasdf****",
"RequestId": "A4AEE536-A97A-40EB-9EBE-53A6948A6928"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 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. | You cannot specify %s and %s at the same time. |
| 400 | DuplicatedParam.InternalPort | The param of %s is duplicated. | Duplicate or occupied InternalPort parameter |
| 400 | DuplicatedParam.ExternalPort | The param of %s is duplicated. | Duplicate parameters are specified for %s. |
| 400 | OperationFailed.AnyPortConfig | Operation failed because any port correspondence any protocol | The operation failed. There is a conflict with another entry, any port or any protocol type. |
| 400 | OperationUnsupported.ForwardEntry | Duplicated destination ip port is unsupported. | You cannot specify duplicate destination IP addresses or destination ports. |
| 400 | InvalidIp.NotInNatgw | The specified Ip not belong to natgateway. | The specified EIP is not associated with the NAT gateway. |
| 400 | QuotaExceeded.ForwardEntry | The quota of %s is exceeded, usage %s/%s. | - |
| 400 | IncorrectStatus.NatIp | The status of %s [%s] is incorrect. | The status of NatIp is incorrect. |
| 400 | Forbidden.IpHasBeenUsedInSnat | The source ip can't be used. Because it has been used in snat. | - |
| 400 | InvalidExternalIp.Malformed | The specified ExternalIp is not a valid IP address. | The specified EIP is invalid. |
| 400 | InvalidInternalIp.Malformed | The specified InternalIp is not a valid IP address. | The specified destination private IP address is invalid. |
| 400 | InvalidExternalPort.Malformed | The specified ExternalPort is not a valid port. | The specified public port is invalid. |
| 400 | InvalidInternalPort.Malformed | The specified InternalPort is not a valid port. | The specified private port is invalid. |
| 400 | Forbidden.DestnationIpOutOfVpcCIDR | The specified Internal Ip is Out of VPC CIDR. | The specified private IP address does not fall within the CIDR block of the VPC. Enter a private IP address that falls within the CIDR block of the VPC. |
| 400 | Forbidden.DestinationIpOutOfVswitchCIDR | The specified Internal Ip is Out of VSwitch CIDR. | - |
| 400 | InvalidProtocal.ValueNotSupported | The specified IpProtocol does not support. | The specified protocol is not supported. |
| 400 | IncorretForwardEntryStatus | Some Forward entry status blocked this operation.. | The operation is not supported because one or more DNAT entries in the DNAT table are in the Pending or Modifying state. |
| 400 | QuotaExceeded.ForwardEntry | Forward entry quota exceeded in this route table. | - |
| 400 | ForwardEntry.Duplicated | The specified ExternalIp, IpProtocol, ExternalPort,InternalIp, InternalPort is duplicated | - |
| 400 | Forbidden.ExternalIp.UsedInSnatTable | The specified ExternalIp is already used in SnatTable | The specified EIP is already used by an SNAT entry. Select a different EIP or delete the SNAT entry. |
| 400 | Forbindden | The specified Instance already bind eip | The ECS instance is associated with an EIP. Disassociate the EIP from the ECS instance before you create forwarding rules. |
| 400 | Forbidden.InternalIpOutOfVpcCIDR | The specified Internal Ip is Out of VPC CIDR. | The private IP address does not fall within the CIDR block of the VPC. |
| 400 | Invalid.natgwNotExist | The specified natgateway not exist. | The specified NAT gateway does not exist. |
| 400 | MissingParameter | Missing mandatory parameter | Required parameters are not specified. Check whether you have specified all required parameters before you call this operation. |
| 400 | AnyPort.PortMustBeZero | any port port must be zero. | - |
| 400 | InvalidParameter.Name.Malformed | The specified Name is not valid. | The specified name format is invalid. Enter the name in the valid format. |
| 400 | IncorrectStatus.ForwardEntry | The status of %s [%s] is incorrect. | The DNAT entry to be deleted is in an invalid state. |
| 400 | OperationFailed.AnyPortConfig | Operation failed because any port correspondence any protocol. | - |
| 400 | Duplicated.DestinationPort | The specified param DestinationPort is duplicated. | - |
| 400 | OperationUnsupported.EipInBinding | Create snat entry with eip in associating status is unsupported. | You cannot use an associated EIP when you create an SNAT entry. |
| 400 | QuotaExceeded.ForwardEntrySessionManytoOne | The dnat session quota is exceed. | The number of DNAT sessions exceeds the upper limit. |
| 400 | TaskConflict | The operation is too frequent, please wait a moment and try again. | Your requests are too frequent. Try again later. |
| 400 | OperationFailed.DnatPortRangeLimit | The maximum number of port ranges that can be specified is exceeded. | The maximum number of port ranges that can be specified is exceeded. |
| 404 | ResourceNotFound.NatIp | The specified resource of %s is not found. | The specified NatIp parameter is not found. |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | The specified region ID does not exist. |
| 404 | InvalidForwardTableId.NotFound | Specified forward table does not exist. | The specified DNAT table does not exist. Check the parameter and try again. |
| 404 | InvalidExternalIp.NotFound | Specified External Ip address does not found on the VRouter | The specified EIP does not exist. |
| 500 | System.Error | ERROR SYSTEM ERROR. | - |
| 500 | InternalError | The request processing has failed due to some unknown error. | An unknown error occurred. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-12-03 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2024-10-23 | The Error code has changed | View Change Details |
| 2024-01-18 | API Description Update. The Error code has changed | View Change Details |
| 2023-06-14 | The Error code has changed | View Change Details |
| 2023-03-30 | The Error code has changed | View Change Details |
| 2023-03-01 | The Error code has changed | View Change Details |