addPortForwardingRules

Prev Next

개요

포트포워딩 룰(Port Forwarding Rule)을 추가합니다. 보유한 서버에 포트포워딩 룰을 추가하여, 설정한 공인 IP와 포트(Port)로 접속할 수 있습니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
portForwardingConfigurationNo Yes String - 포트포워딩설정번호
portForwardingConfigurationNo는 getPortForwardingRuleList 액션을 통해 획득 가능
portForwardingRuleList.N.serverInstanceNo Yes List<String> - 포트포워딩룰리스트.N.서버인스턴스 번호
포트포워딩을 설정할 서버 인스턴스 번호
serverInstanceNo는 getServerInstanceList 액션을 통해 획득 가능
ex) portForwardingRuleList.1.serverInstanceNo=1088217
portForwardingRuleList.N.portForwardingExternalPort Yes List<String> Min : 1, Max : 65534 - 포트포워딩룰리스트.N.포트포워딩외부포트
포트포워딩으로 접속할 외부 포트
외부 포트 번호 범위는 1,024 ~ 65,534이며 서버 접속을 위한 기능 외에 서비스 용도로 사용
ex) portForwardingRuleList.1.portForwardingExternalPort=9090
portForwardingRuleList.N.portForwardingInternalPort Yes List<String> Min : 1, Max : 65534 - 포트포워딩룰리스트.N.포트포워딩내부포트
포트포워딩으로 접속할 내부 포트
다음 포트만 입력 가능 [리눅스 : 22 \ 윈도우 : 3389]
ex) portForwardingRuleList.1.portForwardingInternalPort=22
responseFormatType No String - 응답 결과의 포맷 타입
Options : xml | json
Default : xml

응답

응답 바디

예시

요청 예시

GET {SERVER_API_URL}/addPortForwardingRules
?portForwardingConfigurationNo=31260
&portForwardingRuleList.1.serverInstanceNo=1088217
&portForwardingRuleList.1.portForwardingExternalPort=9090
&portForwardingRuleList.1.portForwardingInternalPort=22

응답 예시

<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>평촌 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>평촌 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>

오류 코드

아래 오류 코드는 이 액션(Action)에서 특징적으로 발생하는 오류입니다. 공통적으로 발생하는 오류에 대한 상세한 설명은 NAVER Cloud Platform API를 참고해주세요

HTTP Response Code 리턴 코드 리턴 메시지
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.