get-data-box-frame-infra-list

인쇄
공유
PDF

기사 요약

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

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

Data Box Frame의 인프라 목록을 조회합니다.

GET https://{endpoint}/data-box-frame/get-data-box-frame-list

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
dataBoxFrameNo	No	Integer		Data Box Frame 번호
pageNo	No	Integer	1 ~ 100	페이지 번호
pageSize	No	Integer	1 ~ 100	페이지 당 조회되는 항목 수

응답

HTTP 상태코드	설명
200	성공
400	요청 정보 오류
401	인증 실패
403	요청 정보에 대한 권한 없음
404	리소스가 존재하지 않음
500	서버 오류

예시

요청 예시

GET https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/get-data-box-frame-infra-list?dataBoxFrameNo=1046

응답 예시

{
  "totalCount": 2,
  "content": [
    {
      "infraType": "Server",
      "instanceName": "admin-1046-1",
      "privateIp": "-.-.-.-",
      "publicIp": "-.-.-.-",
      "osName": "Ubuntu",
      "specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
      "prodSpecId": 2001,
      "userName": "root",
      "useData": "",
      "createDate": "2023-03-15 10:53:09",
      "statusCode": "SET_USE",
      "statusName": "Using",
      "instanceNo": "-",
      "instanceStatusCode": "RUN"
    },
    {
      "infraType": "NAS",
      "instanceName": "pub1046n1",
      "privateIp": "",
      "osName": "",
      "specName": "500",
      "userName": "/mnt/nasr/pub1046n1",
      "useData": "0",
      "createDate": "2023-03-15 10:53:09",
      "statusCode": "USE",
      "statusName": "Using",
      "instanceNo": "-",
      "nasVolumeSize": "500"
    }
  ],
  "usePseudonymInfo": "Y"
}

속성

항목	필수 여부	타입	설명
totalCount	Yes	Integer	Data Box Frame의 Infra 수
infraType	Yes	String	Infra 유형(Server, NAS
instanceName	Yes	String	Infra 명
privateIp	Yes	String	Infra의 비공인 IP
publicIp	No	String	Infra의 공인 IP
osName	Yes	String	서버의 OS 명(NAS의 경우, 빈 String 반환)
specName	Yes	String	서버의 스펙 명(NAS의 경우, NAS의 용량 반환)
userName	Yes	Stirng	서버의 접속 계정명(NAS의 경우, 마운트 경로 반환)
createDate	Yes	String	Data Box Frame 생성 일시
statusCode	Yes	String	Data Box Frame 상태 코드
statusName	Yes	String	Data Box Frame 상태 명
instanceNo	Yes

오류 코드

HTTP Status Code	리턴 코드	설명
200	-	일반적인 요청 성공
400	10001, 130***	요청 정보 및 파라미터 오류
403	10002	요청 정보에 대한 권한 없음
404	10009	리소스가 존재하지 않음
500	130000	서비스 내부 오류
500	139999	연동 서비스 API 호출 오류

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

What's Next

get-data-box-list

요청
응답
예시
속성
오류 코드