Overview
Add a port forwarding rule. You can add a port forwarding rule to your server so that you can access it using the public IP and port you have set.
Request
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| portForwardingConfigurationNo | Yes | String | - Port forwarding configuration number portForwardingConfigurationNo can be obtained through the getPortForwardingRuleList action. |
|
| portForwardingRuleList.N.serverInstanceNo | Yes | List<String> | - Port forwarding rule list.N.Server instance number Instance number of server to be set port forwarding for serverInstanceNo can be obtained through the getServerInstanceList action. e.g., portForwardingRuleList.1.serverInstanceNo=1088217 |
|
| portForwardingRuleList.N.portForwardingExternalPort | Yes | List<String> | Min: 1, Max: 65534 | - Port forwarding rule list.N.Port forwarding external port External port to connect to via port forwarding The external port number range is 1024 to 65,534 and is used for service purposes in addition to the feature for server access. e.g., portForwardingRuleList.1.portForwardingExternalPort=9090 |
| portForwardingRuleList.N.portForwardingInternalPort | Yes | List<String> | Min: 1, Max: 65534 | - Port forwarding rule list.N.Port forwarding internal port Internal port to connect to via port forwarding Only the following ports can be entered [Linux: 22 \ Windows: 3389] e.g., portForwardingRuleList.1.portForwardingInternalPort=22 |
| responseFormatType | No | String | - Format type of the response result Options: xml | json Default: xml |
Response
Response body
Examples
Request example
GET {SERVER_API_URL}/addPortForwardingRules
?portForwardingConfigurationNo=31260
&portForwardingRuleList.1.serverInstanceNo=1088217
&portForwardingRuleList.1.portForwardingExternalPort=9090
&portForwardingRuleList.1.portForwardingInternalPort=22
Response example
<addPortForwardingRulesResponse>
<requestId>1e50cd88-32cb-422d-bf63-fefbbbb805bc</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<portForwardingRuleList>
<portForwardingRule>
<portForwardingConfigurationNo>31260</portForwardingConfigurationNo>
<portForwardingPublicIp>106.10.51.90</portForwardingPublicIp>
<zone>
<zoneNo>3</zoneNo>
<zoneName>KR-2</zoneName>
<zoneCode>KR-2</zoneCode>
<zoneDescription>Pyeongchon zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
<portForwardingExternalPort>9090</portForwardingExternalPort>
<portForwardingInternalPort>22</portForwardingInternalPort>
<serverInstance>
<serverInstanceNo>1088217</serverInstanceNo>
<serverName>s167545541a3</serverName>
<serverDescription></serverDescription>
<cpuCount>4</cpuCount>
<memorySize>8589934592</memorySize>
<baseBlockStorageSize>53687091200</baseBlockStorageSize>
<platformType>
<code>LNX32</code>
<codeName>Linux 32 Bit</codeName>
</platformType>
<loginKeyName>juhoon-kim</loginKeyName>
<isFeeChargingMonitoring>false</isFeeChargingMonitoring>
<publicIp></publicIp>
<privateIp>10.41.83.168</privateIp>
<serverImageName>centos-6.3-32</serverImageName>
<serverInstanceStatus>
<code>RUN</code>
<codeName>Server run state</codeName>
</serverInstanceStatus>
<serverInstanceOperation>
<code>NULL</code>
<codeName>Server NULL OP</codeName>
</serverInstanceOperation>
<serverInstanceStatusName>running</serverInstanceStatusName>
<createDate>2018-11-27T17:42:13+0900</createDate>
<uptime>2018-11-27T18:35:47+0900</uptime>
<serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
<serverProductCode>SPSVRSTAND000005</serverProductCode>
<isProtectServerTermination>false</isProtectServerTermination>
<portForwardingPublicIp>106.10.51.90</portForwardingPublicIp>
<portForwardingExternalPort>9090</portForwardingExternalPort>
<portForwardingInternalPort>22</portForwardingInternalPort>
<zone>
<zoneNo>3</zoneNo>
<zoneName>KR-2</zoneName>
<zoneCode>KR-2</zoneCode>
<zoneDescription>Pyeongchon zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
<region>
<regionNo>1</regionNo>
<regionCode>KR</regionCode>
<regionName>Korea</regionName>
</region>
<baseBlockStorageDiskType>
<code>NET</code>
<codeName>Network Storage</codeName>
</baseBlockStorageDiskType>
<baseBlockStorageDiskDetailType>
<code>HDD</code>
<codeName>HDD</codeName>
</baseBlockStorageDiskDetailType>
<serverInstanceType>
<code>STAND</code>
<codeName>Standard</codeName>
</serverInstanceType>
<userData></userData>
<accessControlGroupList>
<accessControlGroup>
<accessControlGroupConfigurationNo>39995</accessControlGroupConfigurationNo>
<accessControlGroupName>ncloud-default-acg</accessControlGroupName>
<accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
<isDefault>true</isDefault>
<createDate>2018-04-09T11:12:54+0900</createDate>
</accessControlGroup>
</accessControlGroupList>
<instanceTagList/>
</serverInstance>
</portForwardingRule>
</portForwardingRuleList>
</addPortForwardingRulesResponse>
Errors
Errors that may occur while using this action are listed below. For more information about common errors, see NAVER Cloud Platform API.
| HTTP Response Code | Return code | Return message |
|---|---|---|
| 400 | 26035 | Not found certificateName. Please check your input parameter. |
| 400 | 25033 | Currently port forwarding setting is being created/ modifying/ deleting. Please try again a few seconds later. |
| 400 | 24068 | {0} cannot be controlled. instanceNo = {1} |
| 400 | 24069 | Invalid internal port has been configured. Usable internal port(LINUX type : 22, WINDOWS type : 3389) |
| 400 | 24070 | A single external port number is used in multiple rules. External port number : {0} |
| 400 | 24071 | Single server is existing in multiple rules. Server IP address : {0} |
| 400 | 24074 | External internal port as well as server instance number are not designated to port forward rule. |