All Products
Search

This Product

    ENS:ModifyForwardEntry

    Document Center

    ENS:ModifyForwardEntry

    Last Updated:May 08, 2025

    Modifies a Destination Network Address Translation (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:ModifyForwardEntryupdate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ForwardEntryIdstringYes

    The ID of the DNAT entry.

    		dnat-5tfjp3537mi6iokl59g5c****
    ForwardEntryNamestringNo

    The name of the DNAT entry. The name must be 2 to 128 characters in length. It cannot start with http:// or https://.

    		test0
    HealthCheckPortintegerNo

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

    		80
    ExternalIpstringNo

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

    		121.XXX.XXX.28
    ExternalPortstringNo

    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. The first port and the last port are included.
    • If you set ExternalPort to a port range, you must also set InternalPort to a port range. The number of ports in the port ranges must be the same. For example, if you set ExternalPort to 10/20, you can set InternalPort to 80/90.
    • The maximum port range is 1000.
    		22
    InternalIpstringNo

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

    		10.XXX.XXX.50
    InternalPortstringNo

    The private port or port range that is used in 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. The first port and the last port are included.
    • If you set InternalPort to a port range, you must also set ExternalPort to a port range. The number of ports in the port ranges must be the same. For example, if you set ExternalPort to 10/20, you can set InternalPort to 80/90.
    • The maximum port range is 1000.
    		22
    IpProtocolstringNo

    The protocol. Valid values:

    • TCP: forwards TCP packets.
    • UDP: forwards UDP packets.
    • Any (default): forwards all packets.
    		Any

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The ID of the request.

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400Missing%sYou must specify the parameter %s.-
    400Invalid%sThe specified parameter %s is invalid.-
    400ens.interface.errorFailed to call API.-
    400InvalidParameter.DnatNotFoundThe specified dnat is not found.The specified DNAT rule does not exist.
    400IncorretDnatEntryStatusDnat entry status blocked this operation.Dnat status is incorrect, please check Dnat status.
    400InstanceNotFoundInstance not found, please check the InstanceId.Instance not found, please check the instance ID
    400IncorrectInstanceStatusThe current status of the instance does not support this operation.The instance is in a state that does not support the current operation.
    400Forbidden.ExternalPort.DuplicatedThe specified ExternalPort is duplicated.A DNAT rule has been configured for the external port. Do not repeat the configuration.
    400InvalidExternalIp.NotFoundSpecified ExternalIp does not found on the NAT Gateway.The public IP address is not in the NAT Gateway.
    400InvalidPort.MalformedThe specified ExternalPort or InternalPort is not a valid port.The external or internal network port is incorrect.
    400Forbidden.ExternalIpUsedInSnatThe external ip is already in use in the snat rule.The public IP address is already used in the SNAT rule. Please check.
    400InvalidParameter.HealthCheckPortHealthCheckPort is not in the range of InternalPort.The health check port is not in the intranet port range.
    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-03-13The Error code has changed. The request parameters of the API has changedView Change Details