Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getNetworkInterfaceList

Prev Next

VPC 환경에서 이용 가능합니다.

개요

네트워크 인터페이스 리스트를 조회합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String - 리전 코드
네트워크 인터페이스 리스트가 조회될 리전(Region) 결정 가능
regionCode는 getRegionList 액션을 통해 획득 가능
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
subnetName No String - Subnet 번호
네트워크 인터페이스 리스트가 조회될 Subnet의 이름으로 필터링하여 검색 가능
networkInterfaceNoList.N No List<String> - 네트워크 인터페이스 번호 리스트
네트워크 인터페이스 번호로 필터링하여 검색 가능
networkInterfaceNo는 getNetworkInterfaceList 액션을 통해 획득 가능
ex) --networkInterfaceNoList 1234 2345
networkInterfaceName No String - 네트워크 인터페이스 이름
네트워크 인터페이스 이름으로 필터링하여 검색 가능
networkInterfaceStatusCode No String 네트워크 인터페이스 상태 코드
Options : SET | UNSET | USED | NOTUSED
ip No String - IP 주소
네트워크 인터페이스에 할당된 IP 주소로 필터링하여 검색 가능
secondaryIpList.N No List<String> - 보조 IP 리스트
네트워크 인터페이스에 할당된 보조 IP 주소로 필터링하여 검색 가능
네트워크 인터페이스에 할당된 secondaryIp는 getNetworkInterfaceList 액션을 통해 획득 가능
ex) secondaryIpList.1=192.168.0.1&secondaryIpList.2=192.168.0.2
instanceNo No String - 인스턴스 번호
네트워크 인터페이스가 할당되어 있는 디바이스의 인스턴스 번호로 필터링하여 검색 가능
instanceNo는 instanceType에 해당하는 조회 액션을 통해 획득 가능
isDefault No Boolean - 디폴트 여부
네트워크 인터페이스의 디폴트 여부로 필터링하여 검색 가능
Options : true | false
deviceName No String - 디바이스 이름
네트워크 인터페이스가 할당된 디바이스에서의 Ethernet 이름으로 필터링하여 검색 가능
Options : eth0 | eth1 | eth2
serverName No String - 서버 이름
네트워크 인터페이스가 할당된 서버의 이름으로 필터링하여 검색 가능
pageNo No Integer - 페이징된 결과의 페이지 번호
결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize Conditional Integer - 페이징 시 보여줄 각 페이지 사이즈
결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageNo 입력시 반드시 입력 필요

응답

응답 데이터 타입

  • NetworkInterfaceList 타입
NetworkInterfaceList extends CommonResponse
private Integer totalRows;
private List<NetworkInterface> networkInterfaceList = new ArrayList<>();
NetworkInterface
private String networkInterfaceNo;
private String networkInterfaceName;
private String subnetNo;
private Boolean deleteOnTermination;
private Boolean isDefault;
private String deviceName;
private CommonCode networkInterfaceStatus;
private CommonCode instanceType;
private String instanceNo;
private String ip;
private String macAddress;
private AccessControlGroupNoList accessControlGroupNoList;
private String networkInterfaceDescription;
private SecondaryIpList secondaryIpList;
SecondaryIpList
private List<String> secondaryIpList = new ArrayList<>();

예시

요청 예시

ncloud vserver getNetworkInterfaceList --regionCode KR --subnetName test-*** --networkInterfaceNoList ***87 ***88 --networkInterfaceName test-*** --networkInterfaceStatusCode USED --ip ***.***.1.6 --secondaryIpList ***.***.1.7 --instanceNo ***4299 --isDefault ture --deviceName eth0 --serverName test-***

응답 예시

<getNetworkInterfaceListResponse>
  <requestId>73caedc4-073d-4001-a363-efedd90831be</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <networkInterfaceList>
    <networkInterface>
      <networkInterfaceNo>***87</networkInterfaceNo>
      <networkInterfaceName>test-***</networkInterfaceName>
      <subnetNo>***43</subnetNo>
      <deleteOnTermination>true</deleteOnTermination>
      <isDefault>true</isDefault>
      <deviceName>eth0</deviceName>
      <networkInterfaceStatus>
        <code>USED</code>
        <codeName>used </codeName>
      </networkInterfaceStatus>
      <instanceType>
        <code>VSVR</code>
        <codeName>Server (VPC)</codeName>
      </instanceType>
      <instanceNo>***4299</instanceNo>
      <ip>***.***.1.6</ip>
      <macAddress>F2:20:***:***:8A:F5</macAddress>
      <accessControlGroupNoList>
        <accessControlGroupNo>***63</accessControlGroupNo>
      </accessControlGroupNoList>
      <networkInterfaceDescription></networkInterfaceDescription>
      <secondaryIpList>
        <secondaryIp>***.***.1.7</secondaryIp>
      </secondaryIpList>
    </networkInterface>
  </networkInterfaceList>
</getNetworkInterfaceListResponse>