get-bucket-list

Prev Next

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

파일 반출 및 반입에 사용 가능한 Object Storage 버킷을 조회합니다.

참고
  • Object Storage 서비스를 이용 신청하고 버킷을 생성한 후 호출해야 정상 동작합니다.
  • 서브 계정에서 호출할 경우, Object Storage 서비스 이용 권한이 필요할 수 있습니다.

요청

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

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

요청 헤더

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

요청 예시

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

curl --location --request GET 'https://databox.apigw.ntruss.com/api/v1/storage/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 - 버킷 이름 목록

응답 상태 코드

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

응답 예시

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

{
    "totalCount": 2,
    "content": [
        "bckt111",
        "bckt222"
    ]
}