getNetworkInterfaceList

Prev Next

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

네트워크 인터페이스 목록을 조회합니다.

요청

요청 형식에 대해 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET | POST /vserver/v2/getNetworkInterfaceList
참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

Server API에서 공통으로 사용하는 헤더에 대한 정보는 Server 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
regionCode String Optional 리전 코드
  • getRegionList 참조
    • 조회 결과의 첫 번째 리전 (기본값)
subnetName String Optional Subnet 이름으로 필터링
networkInterfaceNoList.N Array Optional 네트워크 인터페이스 번호 목록
  • 네트워크 인터페이스 번호로 필터링
  • <예시> networkInterfaceNoList.1=1234&networkInterfaceNoList.2=2345
networkInterfaceName String Optional 네트워크 인터페이스 이름으로 필터링
networkInterfaceStatusCode String Optional 네트워크 인터페이스 상태 코드로 필터링
  • SET | UNSET | USED | NOTUSED
    • SET: 설정 중
    • UNSET: 해제 중
    • USED: 사용 중
    • NOTUSED: 미사용 중
ip String Optional IP 주소로 필터링
secondaryIpList.N Array Optional Secondary IP 주소 목록
  • Secondary IP 주소로 필터링
  • <예시> secondaryIpList.1=192.168.0.1&secondaryIpList.2=192.168.0.2
instanceNo String Optional 인스턴스 번호로 필터링
  • 디바이스의 인스턴스 조회 API 참조
isDefault Boolean Optional 기본 네트워크 인터페이스 여부로 필터링
  • true | false
    • true: 기본 네트워크 인터페이스
    • false: 기본 네트워크 인터페이스 아님
deviceName String Optional 디바이스 이름으로 필터링
  • eth0 | eth1 | eth2
serverName String Optional 할당 서버 이름으로 필터링
pageNo Integer Optional 페이지 번호
  • 0~N (기본값: 0)
  • 첫 번째 페이지: 0 또는 1 입력
pageSize Integer Conditional 페이지당 항목 수
  • 1~1000 (기본값: 1)
  • pageNo 입력 시 필수 입력
responseFormatType String Optional 응답 데이터의 형식
  • xml (기본값) | json

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getNetworkInterfaceList
?regionCode=KR
&networkInterfaceName=nic
&subnetName=sb1
&deviceName=eth0
&pageNo=1
&pageSize=2
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식에 대해 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
getNetworkInterfaceListResponse Object - 응답 결과
getNetworkInterfaceListResponse.requestId String - 요청에 대한 아이디
  • UUID 형식
getNetworkInterfaceListResponse.returnCode String - 응답 코드
getNetworkInterfaceListResponse.returnMessage String - 응답 메시지

응답 상태 코드

Server API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Server 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "getNetworkInterfaceListResponse": {
    "totalRows": 4,
    "networkInterfaceList": [
      {
        "networkInterfaceNo": "70***6",
        "networkInterfaceName": "nic-70***6",
        "subnetNo": "3***4",
        "deleteOnTermination": true,
        "isDefault": true,
        "deviceName": "eth0",
        "networkInterfaceStatus": {
          "code": "USED",
          "codeName": "사용중"
        },
        "instanceType": {
          "code": "VSVR",
          "codeName": "Server (VPC)"
        },
        "instanceNo": "10*****18",
        "ip": "10.0.10.6",
        "macAddress": "F2:**:**:**:**:AC",
        "enableFlowLog": false,
        "accessControlGroupNoList": [
          "1***1"
        ],
        "networkInterfaceDescription": "",
        "secondaryIpList": []
      },
      {
        "networkInterfaceNo": "70***5",
        "networkInterfaceName": "nic-70***5",
        "subnetNo": "3***4",
        "deleteOnTermination": true,
        "isDefault": true,
        "deviceName": "eth0",
        "networkInterfaceStatus": {
          "code": "USED",
          "codeName": "사용중"
        },
        "instanceType": {
          "code": "VSVR",
          "codeName": "Server (VPC)"
        },
        "instanceNo": "10*****61",
        "ip": "10.0.10.7",
        "macAddress": "F2:**:**:**:**:1E",
        "enableFlowLog": false,
        "accessControlGroupNoList": [
          "1***1"
        ],
        "networkInterfaceDescription": "",
        "secondaryIpList": []
      }
    ],
    "requestId": "85b22651-****-****-****-45a5ed2bc52b",
    "returnCode": "0",
    "returnMessage": "success"
  }
}