get-box-summary-info

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

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

요청

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

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

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`fenceId`	Integer	Required	Datafence 번호 get-datafence 참조
`boxId`	Integer	Required	Box 번호 get-box-list 참조

요청 예시

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-box-summary-info?fenceId=26&boxId=74' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`boxId`	Integer	-	Box 번호
`boxName`	String	-	Box 이름
`description`	String	-	Box에 대한 설명
`mountCount`	Integer	-	Box 상태 코드 `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: 인프라 생성 중 `USE`: 이용 중 `ING`: 변경 중 `RETURN`: 반납 중 `TERMINATE`: 반납 완료
`nasCount`	Integer	-	Box 저장소의 개수
`nasTotalSize`	Integer	-	Box 저장소의 총 용량(GB)
`nasInstanceNoList`	Array	-	NAS 인스턴스 번호 목록
`nasTotalUseSize`	Integer	-	Box 저장소의 총 사용량(GB)
`exportApplyCount`	Integer	-	반출 심사 요청 횟수
`webBlockStatus`	Boolean	-	외부망 차단 여부 `true` \| `false` `true`: 차단 `false`: 연결
`statusCode`	String	-	Box 상태 코드 `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: 인프라 생성 중 `USE`: 이용 중 `ING`: 변경 중 `RETURN`: 반납 중 `TERMINATE`: 반납 완료
`statusName`	String	-	Box 상태 이름 `인프라 생성중` \| `이용중` \| `변경 중` \| `반납중` \| `반납완료`
`createDate`	String	-	Box 생성 일시 ISO 8601 형식(UTC+9 포함)

응답 상태 코드

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

응답 예시

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

{
    "boxId": 74,
    "boxName": "box1",
    "description": "",
    "mountCount": 0,
    "nasCount": 1,
    "nasTotalSize": 500,
    "nasInstanceNoList": [
        28080389
    ],
    "nasTotalUseSize": 0,
    "exportApplyCount": 0,
    "webBlockStatus": true,
    "statusCode": "USE",
    "statusName": "이용중",
    "createDate": "2025-04-21T11:24:01+09:00"
}