CreateDnatEntry

1. API Description

This API is used to create a DNAT rule.

Note

By default, you can create up to 100 DNAT rules for a NAT gateway. For additional quota, please contact us.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
natGatewayId	Yes	String	NAT gateway ID.
eipId	Yes	String	The elastic IP ID configured in the DNAT rule.
privateIp	Yes	String	The private IP address configured in the DNAT rule.
protocol	Yes	DnatEntryProtocol	The protocol type configured in the DNAT rule.
listenerPort	No	String	The public port or port range forwarded by the DNAT rule. Valid values: 1–65535.
internalPort	No	String	The private port or port range forwarded by the DNAT rule. Valid values: 1–65535.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required to locate a problem.
dnatEntryId	String	The unique ID of the DNAT rule.

4. Code Example

Example

Create a DNAT entry.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateDnatEntry
<Common Request Params>

Request：
{
    "natGatewayId": "<natGatewayId>",
    "eipId": "<eipId>",
    "privateIp": "10.0.0.2",
    "protocol": "TCP",
    "listenerPort": "1-30",
    "internalPort": "1-30"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "dnatEntryId": "<dnatEntryId>"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code	Error Code	Description
404	INVALID_NAT_NOT_FOUND	NAT gateway does not exist.
400	OPERATION_DENIED_NAT_STATUS	NAT gateway state is not RUNNING.
404	INVALID_EIP_NOT_FOUND	The elastic IP is not found.
400	OPERATION_DENIED_EIP_NOT_ASSIGNED	The elastic IP is not bound.
400	OPERATION_DENIED_EIP_REPEAT_ASSIGN	The elastic IP has been bound already.
400	OPERATION_DENIED_DNAT_ENTRY_COUNT_LIMIT	The number of DNAT entries is limited.