get-data-box-summary-info

인쇄
공유
PDF

기사 요약

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

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

Data Box Frame 내 Data Box의 요약 정보를 조회합니다.

GET https://{endpoint}/data-box/get-data-box-summary-info

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
dataBoxFrameNo	Yes	Integer		Data Box Frame 번호
dataBoxNo	Yes	Integer		Data Box 번호

응답

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

예시

요청 예시

GET https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-data-box-summary-info?dataBoxFrameNo=1046&dataBoxNo=194

응답 예시

{
  "dataBoxName": "BOX#3",
  "sslVpnCount": 1,
  "connectSslVpnUrl": "https://sslvpn-kr-vpc-02.ncloud.com",
  "webBlockStatus": true,
  "mountCount": 0,
  "nasCount": 1,
  "nasTotalSize": 600,
  "nasTotalUseSize": "0",
  "createDate": "2023-04-04 16:24:37",
  "statusCode": "USE",
  "exportApplyCount": 1,
  "memo": ""
}

속성

항목	필수 여부	타입	설명
dataBoxName	Yes	String	Data Box 명
sslVpnCount	Yes	Integer	Data Box의 SSL VPN 사용 가능 계정 수
conectSslVpnUrl	Yes	String	SSL VPN 접속 url
webBlockStatus	Yes	Boolean	외부망 연결/차단 여부(true: 차단, false: 연결)
mountCount	Yes	Integer	공용 데이터 열람 수
nasCount	Yes	Integer	Data Box의 개별 저장소 수
nasTotalSize	Yes	Integer	Data Box의 개별 저장소의 총 용량
nasTotalUseSize	Yes	String	Data Box의 개별 저장소의 총 사용량
createDate	Yes	String	Data Box 생성 일시
statusCode	Yes	String	Data Box 상태 코드
exportApplyCount	Yes	Integer	반출 심사 요청 수
memo	Yes	String	Data Box 메모

오류 코드

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

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

What's Next

get-data-box-infra-list

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