getPublicIpInstanceList

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

개요

공인 IP 인스턴스 리스트를 조회합니다.

요청

요청 파라미터

파라미터 명	필수 여부	타입	제약사항	설명
isAssociated	No	Boolean		- 할당 여부 할당된 공인 IP, 할당되지 않은 공인 IP 조회 가능 Options : true \| false
publicIpInstanceNoList.N	No	String	중복 불가	- 조회할 공인 IP 인스턴스 번호 리스트 ex) publicIpInstanceNoList.1=937520&publicIpInstanceNoList.2=932956
publicIpList.N	No	List<String>	Min : 5, Max : 15	- 조회할 공인 IP 리스트 ex) publicIpList.1=106.10.53.67
searchFilterName	No	String		- 검색할 필터명 공인 IP(publicIp)와 할당된 서버명(associatedServerName)로 필터링하여 검색 가능 Options : publicIp \| associatedServerName `[대소문자 구분 없음]` searchFilterName은 아래의 searchFilterValue 값과 mapping하여 사용 ex) searchFilterName=publicIp&searchFilterValue=106.10.53.67 ex) searchFilterName=associatedServerName&searchFilterValue=s1669aa4e78c
searchFilterValue	No	String		- 검색할 필터값 위의 searchFilterName 값과 mapping할 값 입력
regionNo	No	String		- 리전 번호 공인 IP 인스턴스 리스트를 리전(Region)을 이용해 필터링 가능 regionNo는 getRegionList 액션을 통해 획득 가능
zoneNo	No	String		- ZONE번호 공인 IP 인스턴스 리스트를 존(zone)을 이용해 필터링 가능 zoneNo는 getZoneList 액션을 통해 획득 가능 필터를 설정하지 않으면 해당 리전(Region)의 존(zone)에 속한 공인 IP 리스트가 모두 선택됨
pageNo	No	Integer	Min : 0, Max : 2147483647	- 페이징 된 결과의 페이지 번호 결과값을 pageNo를 이용하여 페이징 처리 가능
pageSize	No	Integer	Min : 0, Max : 2147483647	- 페이징시 보여줄 각 페이지 사이즈 결과값을 pageSize를 이용하여 페이징 처리 가능
sortedBy	No	String		- 정렬 대상 공인 IP와 공인 IP 인스턴스 번호로 정렬 가능 Options : publicIp (공인 IP) \| publicIpInstanceNo (공인 IP 인스턴스 번호) `[대소문자 구분 없음]` Default : publicIpInstanceNo sortedBy는 아래의 sortingOrder와 mapping하여 사용 ex) sortedBy=publicIp&sortingOrder=ascending ex) sortedBy=publicIpInstanceNo&sortingOrder=descending
sortingOrder	No	String		- 정렬 순서 위에서 설정한 SortedBy의 오름차순/내림차순 정렬을 설정함 ascending (오름차순) \| descending (내림차순) `[대소문자 구분 없음]` default : ascending

응답

응답 바디

PublicIpInstanceList

예시

요청 예시

GET {SERVER_API_URL}/getPublicIpInstanceList
?searchFilterName=associatedServerName
&searchFilterValue=s1669aa4e78c

응답 예시

<getPublicIpInstanceListResponse>
  <requestId>9e27266d-049c-42c7-a04a-a884290dddb1</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <publicIpInstanceList>
    <publicIpInstance>
      <publicIpInstanceNo>1081432</publicIpInstanceNo>
      <publicIp>106.10.46.237</publicIp>
      <publicIpDescription></publicIpDescription>
      <createDate>2018-11-23T18:33:45+0900</createDate>
      <publicIpInstanceStatusName>used</publicIpInstanceStatusName>
      <publicIpInstanceStatus>
        <code>USED</code>
        <codeName>NET USED state</codeName>
      </publicIpInstanceStatus>
      <publicIpInstanceOperation>
        <code>NULL</code>
        <codeName>NET NULL OP</codeName>
      </publicIpInstanceOperation>
      <publicIpKindType>
        <code>GEN</code>
        <codeName>General</codeName>
      </publicIpKindType>
      <serverInstanceAssociatedWithPublicIp>
        <serverInstanceNo>1021003</serverInstanceNo>
        <serverName>s1669aa4e78c</serverName>
        <serverDescription>내서버이미지 카피 오류테스트</serverDescription>
        <cpuCount>2</cpuCount>
        <memorySize>4294967296</memorySize>
        <baseBlockStorageSize>53687091200</baseBlockStorageSize>
        <platformType>
          <code>LNX64</code>
          <codeName>Linux 64 Bit</codeName>
        </platformType>
        <loginKeyName>juhoon-kim</loginKeyName>
        <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
        <publicIp>106.10.46.237</publicIp>
        <privateIp>10.41.3.81</privateIp>
        <serverImageName>tensorflow-centos-7.3-64</serverImageName>
        <serverInstanceStatus>
          <code>NSTOP</code>
          <codeName>Server normal stopped state</codeName>
        </serverInstanceStatus>
        <serverInstanceOperation>
          <code>NULL</code>
          <codeName>Server NULL OP</codeName>
        </serverInstanceOperation>
        <serverInstanceStatusName>stopped</serverInstanceStatusName>
        <createDate>2018-10-22T16:19:50+0900</createDate>
        <uptime>2018-11-23T17:38:44+0900</uptime>
        <serverImageProductCode>SPSW0LINUX000066</serverImageProductCode>
        <serverProductCode>SPSVRSSD00000003</serverProductCode>
        <isProtectServerTermination>false</isProtectServerTermination>
        <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>
        <region>
          <regionNo>1</regionNo>
          <regionCode>KR</regionCode>
          <regionName>Korea</regionName>
        </region>
        <baseBlockStorageDiskType>
          <code>NET</code>
          <codeName>Network Storage</codeName>
        </baseBlockStorageDiskType>
        <baseBlockStorageDiskDetailType>
          <code>SSD</code>
          <codeName>SSD</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/>
      </serverInstanceAssociatedWithPublicIp>
      <zone>
        <zoneNo>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>평촌 zone</zoneDescription>
        <regionNo>1</regionNo>
      </zone>
    </publicIpInstance>
  </publicIpInstanceList>
</getPublicIpInstanceListResponse>

이 문서가 도움이 되었습니까?

What's Next

getPublicIpTargetServerInstanceList

개요
요청
응답
예시

태그