MENU
      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

        응답

        HTTP 상태코드설명
        200성공
        400요청 정보 오류
        401인증 실패
        403요청 정보에 대한 권한 없음
        404리소스가 존재하지 않음
        500서버 오류

        예시

        요청 예시

        https://databoxframe.apigw.ntruss.com/api/v1/bucket/get-bucket-list
        HTTP

        응답 예시

        {
          "totalCount": 4,
          "content": [
            {
              "disabled": false,
              "bucketName": "bucket1"
            },
            {
              "disabled": false,
              "bucketName": "bucket2"
            },
            {
              "disabled": false,
              "bucketName": "bucket3"
            },
            {
              "disabled": false,
              "bucketName": "bucket4"
            }
          ]
        }
        JSON

        속성

        항목필수 여부타입제약 사항설명
        totalCountYesIntegerBucket의 총 수
        disabledYesBoolean사용 가능 여부(사용 가능: false, 사용 불가능: true)
        bucketNameYesStringBucket 명

        오류 코드

        HTTP Status Code리턴 코드설명
        200-일반적인 요청 성공
        40010001,
        130***
        요청 정보 및 파라미터 오류
        40310002요청 정보에 대한 권한 없음
        40410009리소스가 존재하지 않음
        500130000서비스 내부 오류
        500139999연동 서비스 API 호출 오류

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.