get-data-box-list
- 인쇄
- PDF
get-data-box-list
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Data Box Frame 내 Data Box의 목록을 조회 합니다.
GET https://{endpoint}/data-box/get-data-box-list
요청
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| dataBoxFrameNo | Yes | 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/get-data-box-list?dataBoxFrameNo=1046&pageNo=1&pageSize=10
응답 예시
{
"totalCount": 1,
"content": [
{
"dataBoxNo": "194",
"dataBoxName": "BOX#3",
"memo": "",
"createDate": "2023-04-04 16:24:37",
"statusCode": "USE",
"statusName": "Using"
}
]
}
속성
| 항목 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| totalCount | Yes | Integer | Data Box의 총 수 | |
| dataBoxNo | Yes | String | Data Box 번호 | |
| dataBoxName | Yes | String | Data Box 명 | |
| createDate | Yes | String | Data Box 생성 일시 | |
| statusCode | Yes | String | Data Box 상태 코드 | |
| statusName | Yes | String | Data Box 상태명 | |
| memo | Yes | String | Data Box 메모 | |
| disabled | No | Boolean | Data Box 접근 가능 여부(for Sub Account) |
오류 코드
| HTTP Status Code | 리턴 코드 | 설명 |
|---|---|---|
| 200 | - | 일반적인 요청 성공 |
| 400 | 10001, 130*** | 요청 정보 및 파라미터 오류 |
| 403 | 10002 | 요청 정보에 대한 권한 없음 |
| 404 | 10009 | 리소스가 존재하지 않음 |
| 500 | 130000 | 서비스 내부 오류 |
| 500 | 139999 | 연동 서비스 API 호출 오류 |
이 문서가 도움이 되었습니까?