get-bucket-list

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

Data Box Frame의 반입 또는 반출 시 사용할 Object Storage 서비스의 버킷 목록을 조회합니다.

참고

get-bucket-list API를 사용하려면 우선 Object Storage 서비스 이용 신청 후 버킷을 생성해야 합니다. 이용 신청 및 버킷 생성 방법은 다음을 참조해 주십시오.

네이버 클라우드 플랫폼 콘솔에서 이용 신청 후 생성: Object Storage 사용 가이드 참조
API를 사용하여 생성: PutBucket 참조

요청

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

메서드	URI
GET	/api/v1/bucket/get-bucket-list

요청 헤더

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

요청 예시

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

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/bucket/get-bucket-list' \
--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	-	버킷 목록

`content`

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

필드	타입	필수 여부	설명
`disabled`	Boolean	-	버킷 사용 가능 여부 `true` \| `false` `true`: 불가능 `false`: 가능
`bucketName`	String	-	버킷 이름

응답 상태 코드

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

응답 예시

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

{
    "totalCount": 1,
    "content": [
        {
            "disabled": false,
            "bucketName": "testddfdas"
        }
    ]
}