getPortForwardingConfigurationList

Prev Next

Can be used in a Classic environment.

Overview

Searches the port forwarding configuration list.

Description

Searches the port forwarding configuration list information.

Request parameter

Parameter name Requirement status Type Restrictions Description
regionNo No String - Region number
It can determine the region to search the port forwarding configuration list from.
You can obtain regionNo through the getRegionList action.
serverInstanceNoList No List<String> - List of server instance numbers
You can get the port forwarding configuration list for the specified server instance.
You can obtain serverInstanceNo through the getServerInstanceList action.
E.g., serverInstanceNoList 12345 serverInstanceNoList 23456
portForwardingPublicIpList No List<String> - Port forwarding public IP list
It's possible to get it by filtering with port forwarding public IP.
You can obtain portForwardingPublicIp through the getServerInstanceList action.
E.g., portForwardingPublicIpList "192.168.0.1" portForwardingPublicIpList "192.168.0.2"

Response data type

  • PortForwardingConfigurationList type
PortForwardingConfigurationList extends CommonResponse
private Integer totalRows;
private List portForwardingConfigurationList = new ArrayList<>();
PortForwardingRule
private String portForwardingConfigurationNo;
private String portForwardingPublicIp;
private ServerInstanceNoList serverInstanceNoList;

Examples

Call

ncloud server getPortForwardingConfigurationList

Response

{
  "getPortForwardingConfigurationListResponse": {
    "requestId": "e2068abf-aa0d-46d6-8e7f-8e86c9805f5e",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "portForwardingConfigurationList": [
      {
        "portForwardingConfigurationNo": "***536",
        "portForwardingPublicIp": "***.***.160.56",
        "serverInstanceNoList": [
          "***5058"
        ]
      }
    ]
  }
}
<getPortForwardingConfigurationListResponse>
  <requestId>e2068abf-aa0d-46d6-8e7f-8e86c9805f5e</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <portForwardingConfigurationList>
    <portForwardingConfiguration>
      <portForwardingConfigurationNo>***536</portForwardingConfigurationNo>
      <portForwardingPublicIp>***.***.160.56</portForwardingPublicIp>
      <serverInstanceNoList>
        <serverInstanceNo>***5058</serverInstanceNo>
      </serverInstanceNoList>
    </portForwardingConfiguration>
  </portForwardingConfigurationList>
</getPortForwardingConfigurationListResponse>