get-data-box-summary-info

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

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

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/data-box/get-data-box-summary-info

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`dataBoxFrameNo`	Integer	Required	Data Box Frame 번호 get-data-box-frame-list 참조
`dataBoxNo`	Integer	Required	Data Box 번호 get-data-box-list 참조

요청 예시

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

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-data-box-summary-info?dataBoxFrameNo=83&dataBoxNo=381' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`dataBoxName`	String	-	Data Box 이름
`sslVpnCount`	Integer	-	SSL VPN 사용 가능한 계정 수
`connectSslVpnUrl`	String	-	SSL VPN 접속 URL
`webBlockStatus`	Boolean	-	외부망 차단 여부 `true` \| `false` `true`: 차단 `false`: 연결
`mountCount`	Integer	-	공용 데이터 열람 횟수
`nasCount`	Integer	-	Data Box 저장소의 개수
`nasTotalSize`	Integer	-	Data Box 저장소의 총 용량(GB)
`nasTotalUseSize`	String	-	Data Box 저장소의 총 사용량(GB)
`createDate`	String	-	Data Box 생성 일시 YYYY-MM-DD HH:mm:ss 형식
`statusCode`	String	-	Data Box 상태 코드 `READY` \| `INIT` \| `USE` \| `ING` \| `RTN` \| `TERMT` `READY`: 신청 중 `INIT`: 생성 중 `USE`: 이용 중 `ING`: 변경 중 `RTN`: 반납 중 `TERMT`: 반납 완료
`exportApplyCount`	Integer	-	반출 심사 요청 횟수
`memo`	String	-	Data Box에 대한 설명

응답 상태 코드

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

응답 예시

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

{
    "dataBoxName": "BOX#1",
    "sslVpnCount": 1,
    "connectSslVpnUrl": "https://sslvpn-kr-vpc-***.ncloud.com",
    "webBlockStatus": true,
    "mountCount": 0,
    "nasCount": 1,
    "nasTotalSize": 500,
    "nasTotalUseSize": "0",
    "createDate": "2025-03-25 11:20:11",
    "statusCode": "USE",
    "exportApplyCount": 0,
    "memo": "dbf001"
}