getCloudHadoopObjectList

Prev Next

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

Cloud Hadoop 클러스터에 연동된 Object Storage 버킷의 객체 목록을 조회합니다.

요청

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

메서드 URI
GET | POST /vhadoop/v2/getCloudHadoopObjectList
참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
regionCode String Optional 리전 코드
  • getRegionList 참조
    • 조회 결과의 첫 번째 리전(기본값)
bucketName String Required 버킷 이름
prefix String Optional 객체 이름 접두어
  • 접두어로 시작하는 객체만 필터링
delimiter String Optional 구분 문자
  • 구분 문자가 포함된 객체는 응답의 commonPrefixList에 접두어만 표시되며, 개별 객체 목록에서 제외
maxKeys String Optional 응답에 표시할 최대 파일 수
marker String Optional 응답 시작점
  • 시작점 이후의 객체를 UTF-8 바이너리 순서로 표시
responseFormatType String Optional 응답 데이터의 형식
  • xml (기본값) | json

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/vhadoop/v2/getCloudHadoopObjectList?regionCode=KR&bucketName=bk4hadoop&prefix=CONFIG&delimiter=%2FV2&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
getCloudHadoopObjectListResponse Object - 응답 결과
getCloudHadoopObjectListResponse.commonPrefixList Array - 공통 접두어를 가진 객체 목록
getCloudHadoopObjectListResponse.requestId String - 요청에 대한 아이디
  • UUID 형식
getCloudHadoopObjectListResponse.returnCode String - 응답 코드
getCloudHadoopObjectListResponse.returnMessage String - 응답 메시지

응답 상태 코드

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

응답 예시

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

{
    "getCloudHadoopObjectListResponse": {
        "commonPrefixList": [
            "CONFIG-BACKUP/V2"
        ],
        "cloudHadoopObjectList": [
            {
                "key": "CONFIG-BACKUP/",
                "lastModified": "2025-02-25T10:03:37+0900",
                "size": 0
            },
            {
                "key": "CONFIG-BACKUP/V1/",
                "lastModified": "2025-02-28T09:26:39+0900",
                "size": 0
            },
            {
                "key": "CONFIG-BACKUP/V1/cluster01_2025-02-20-16-40-52_config.tar",
                "lastModified": "2025-02-28T09:26:52+0900",
                "size": 33660
            },
            {
                "key": "CONFIG-BACKUP/cluster01_2025-02-20-16-40-52_config.tar",
                "lastModified": "2025-02-20T16:41:00+0900",
                "size": 33660
            },
            {
                "key": "CONFIG-BACKUP/cluster01_2025-02-21-14-16-09_config.tar",
                "lastModified": "2025-02-21T14:16:14+0900",
                "size": 33652
            },
            {
                "key": "CONFIG-BACKUP/cluster01_2025-02-21-14-17-01_config.tar",
                "lastModified": "2025-02-21T14:17:07+0900",
                "size": 33662
            },
            {
                "key": "CONFIG-BACKUP/cluster01_2025-02-25-10-03-31_config.tar",
                "lastModified": "2025-02-25T10:03:37+0900",
                "size": 33653
            }
        ],
        "requestId": "e08df7b1-****-****-****-1f3cc3516a4a",
        "returnCode": "0",
        "returnMessage": "success"
    }
}