버킷 목록 조회

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

Search Engine 클러스터 스냅샷을 저장할 수 있는 Object Storage 버킷 목록을 조회합니다.

참고

Object Storage에 접근하려면 API 인증키가 필요합니다. API 인증키 설정 방법은 다음을 참조해 주십시오.

네이버 클라우드 플랫폼 콘솔에서 설정: Search Engine Service 사용 가이드
API를 사용하여 설정: API 인증키 확인 및 생성 > API 인증키 설정

요청

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

메서드	URI
GET	/api/v2/snapshot/getBucketList/{serviceGroupInstanceNo} (수도권)
GET	/api/krs-v2/snapshot/getBucketList/{serviceGroupInstanceNo} (남부권)

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`serviceGroupInstanceNo`	Integer	Required	클러스터 인스턴스 번호 클러스터 목록 조회 참조

요청 예시

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

curl --location --request GET 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/snapshot/getBucketList/1037*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`code`	Integer	-	응답 코드
`message`	String	-	응답 메시지
`result`	Object	-	응답 결과
`result.bucketList`	Array	-	버킷 목록
`requestId`	String	-	요청에 대한 아이디 UUID 형식

`result.bucketList`

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

필드	타입	필수 여부	설명
`name`	String	-	버킷 이름
`bytesUsed`	Integer	-	버킷 크기
`objectCount`	Integer	-	오브젝트 수
`creationTime`	Integer	-	버킷 생성 일시 Unix Timestamp 형식
`bucketProtectionState`	String	-	버킷의 보안 설정 여부 `ENABLED` \| `DISABLED` `ENABLED`: 보안 설정(스냅샷 저장 불가) `DISABLED`: 보안 미설정(스냅샷 저장 가능)
`permission`	String	-	버킷 접근 권한 소유 여부 `Allow` \| `Deny` `Allow`: 접근 허용 `Deny`: 접근 불가

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "bucketList": [
            {
                "name": "bk.lib",
                "bytesUsed": 40940,
                "objectCount": 15,
                "creationTime": 1742341291251,
                "bucketProtectionState": "DISABLED",
                "permission": "Allow"
            },
            {
                "name": "bk.ses.snapshot",
                "bytesUsed": 512924,
                "objectCount": 108,
                "creationTime": 1742520149085,
                "bucketProtectionState": "DISABLED",
                "permission": "Allow"
            },
            {
                "name": "bucket3",
                "bytesUsed": 68557,
                "objectCount": 9,
                "creationTime": 1742189392156,
                "bucketProtectionState": "DISABLED",
                "permission": "Allow"
            }
        ]
    },
    "requestId": "b67c900f-****-****-****-6ba8f81cafe6"
}