get-bucket-list
- 인쇄
- PDF
get-bucket-list
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Data Box Frame의 반입/반출 시 사용될 bucket 목록을 조회합니다.
- API 사용을 위해서는 Object Storage 이용 신청 후 버킷 생성이 선행되어야 합니다.
- Sub Account로 이용 시 Object Storage의 권한이 필요할 수 있습니다.
GET https://{endpoint}/bucket/get-bucket-list
응답
| HTTP 상태코드 | 설명 |
|---|---|
| 200 | 성공 |
| 400 | 요청 정보 오류 |
| 401 | 인증 실패 |
| 403 | 요청 정보에 대한 권한 없음 |
| 404 | 리소스가 존재하지 않음 |
| 500 | 서버 오류 |
예시
요청 예시
https://databoxframe.apigw.ntruss.com/api/v1/bucket/get-bucket-list
응답 예시
{
"totalCount": 4,
"content": [
{
"disabled": false,
"bucketName": "bucket1"
},
{
"disabled": false,
"bucketName": "bucket2"
},
{
"disabled": false,
"bucketName": "bucket3"
},
{
"disabled": false,
"bucketName": "bucket4"
}
]
}
속성
| 항목 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| totalCount | Yes | Integer | Bucket의 총 수 | |
| disabled | Yes | Boolean | 사용 가능 여부(사용 가능: false, 사용 불가능: true) | |
| bucketName | Yes | String | Bucket 명 |
오류 코드
| HTTP Status Code | 리턴 코드 | 설명 |
|---|---|---|
| 200 | - | 일반적인 요청 성공 |
| 400 | 10001, 130*** | 요청 정보 및 파라미터 오류 |
| 403 | 10002 | 요청 정보에 대한 권한 없음 |
| 404 | 10009 | 리소스가 존재하지 않음 |
| 500 | 130000 | 서비스 내부 오류 |
| 500 | 139999 | 연동 서비스 API 호출 오류 |
이 문서가 도움이 되었습니까?