get-data-box-list

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

Data Box 목록을 조회합니다.

요청

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

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

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`dataBoxFrameNo`	Integer	Required	Data Box Frame 번호 get-data-box-frame-list 참조
`pageNo`	Integer	Optional	페이지 번호 1~100 (기본값: 1)
`pageSize`	Integer	Optional	페이지 출력 수 1~100 (기본값: 10)

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`totalCount`	Integer	-	응답 결과 수
`content`	Array	-	Data Box 목록

`content`

content에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`dataBoxNo`	String	-	Data Box 번호
`dataBoxName`	String	-	Data Box 이름
`memo`	String	-	Data Box에 대한 설명
`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`: 반납 완료
`statusName`	String	-	Data Box 상태 이름 `Request for creating` \| `Initial State` \| `Using` \| `Changing` \| `Returning` \| `Terminated` `Request for creating`: 신청 중 `Initial State`: 생성 중 `Using`: 이용 중 `Changing`: 변경 중 `Returning`: 반납 중 `Terminated`: 반납 완료
`disabled`	Boolean	-	Data Box 접근 가능 여부 `true` \| `false` 서브 계정인 경우에 표시

응답 상태 코드

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

응답 예시

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

{
    "totalCount": 1,
    "content": [
        {
            "dataBoxNo": "381",
            "dataBoxName": "BOX#1",
            "memo": "dbf001",
            "createDate": "2025-03-25 11:20:11",
            "statusCode": "USE",
            "statusName": "Using"
        }
    ]
}