MENU
      getCloudHadoopInstanceList
        • PDF

        getCloudHadoopInstanceList

        • PDF

        기사 요약

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

        Cloud Hadoop 클러스터 목록을 조회합니다.

        요청

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

        메서드URI
        GET | POST/hadoop/v2/getCloudHadoopInstanceList
        참고

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

        요청 헤더

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

        요청 쿼리 파라미터

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

        필드타입필수 여부설명
        regionNoStringOptional리전 번호
        zoneNoStringOptional존 번호로 필터링
        cloudHadoopInstanceNoStringOptional클러스터 인스턴스 번호로 필터링
        searchFilterNameStringOptional검색 컬럼
        • clusterName: 클러스터 이름 (유효 값)
        • searchFilterValue를 입력한 경우, 필수 입력
        searchFilterValueStringOptional검색 키워드
        • 검색 컬럼 옵션(clusterName)과 전체 일치하지 않는 값을 입력한 경우, 응답에 빈 값 표시
        • searchFilterName 없이 요청하는 경우, 전체 목록 표시
        pageNoIntegerOptional페이지 번호
        • 0~2147483647 (기본값: 0)
        pageSizeIntegerOptional페이지 출력 수
        • 1~2147483647 (기본값: 1)
        responseFormatTypeStringOptional응답 데이터의 형식
        • xml (기본값) | json

        요청 예시

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

        curl --location --request GET 'https://ncloud.apigw.ntruss.com/hadoop/v2/getCloudHadoopInstanceList?regionNo=1&zoneNo=3&searchFilterName=clusterName&searchFilterValue=cluster&pageNo=0&pageSize=1&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}' \
        --header 'x-ncp-apigw-api-key: {API Key}'
        Shell

        응답

        응답 형식을 설명합니다.

        응답 바디

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

        필드타입필수 여부설명
        getCloudHadoopInstanceListResponseObject-응답 결과
        getCloudHadoopInstanceListResponse.totalRowsInteger-응답 결과 수
        getCloudHadoopInstanceListResponse.cloudHadoopInstanceListArray-클러스터 목록
        getCloudHadoopInstanceListResponse.requestIdString-요청에 대한 아이디
        • UUID 형식
        getCloudHadoopInstanceListResponse.returnCodeString-응답 코드
        getCloudHadoopInstanceListResponse.returnMessageString-응답 메시지

        getCloudHadoopInstanceListResponse.cloudHadoopInstanceList

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

        필드타입필수 여부설명
        cloudHadoopInstanceNoString-클러스터 인스턴스 번호
        cloudHadoopClusterNameString-클러스터 이름
        cloudHadoopImageProductCodeString-클러스터 이미지 코드
        cloudHadoopClusterTypeObject-클러스터 타입 정보
        • cloudHadoopInstanceStatusNamerunning 또는 settingup인 경우, 표시
        cloudHadoopClusterType.codeString-클러스터 타입 코드
        • CHADP | HBASE | SPARK | PRESTO
          • CHADP: Core Hadoop
          • HBASE: HBase
          • SPARK: Spark
          • PRESTO: Presto
        cloudHadoopClusterType.codeNameString-클러스터 타입 코드 이름
        masterNodeCpuCountInteger-마스터노드 CPU 수
        masterNodeCountInteger-마스터노드 수
        masterNodeMemorySizeInteger-마스터노드 메모리 용량(Byte)
        workerNodeCpuCountInteger-작업자노드 CPU 수
        workerNodeCountInteger-작업자노드 수
        workerNodeMemorySizeInteger-작업자노드 메모리 용량(Byte)
        edgeNodeCpuCountInteger-엣지노드 CPU 수
        edgeNodeCountInteger-엣지노드 수
        edgeNodeMemorySizeInteger-엣지노드 메모리 용량(Byte)
        cloudHadoopInstanceStatusObject-클러스터 상태 정보
        • cloudHadoopInstanceStatusNamecreating인 경우, 표시
        cloudHadoopInstanceStatus.codeString-클러스터 상태 코드
        • INIT: Cloud Hadoop INIT 상태
        cloudHadoopInstanceStatus.codeNameString-클러스터 상태 코드 이름
        cloudHadoopInstanceOperationObject-클러스터 운영 정보
        • cloudHadoopInstanceStatusNamerunning 또는 settingup인 경우, 표시
        cloudHadoopInstanceOperation.codeString-클러스터 운영 코드
        • SETUP | NULL
          • SETUP: Cloud Hadoop SETUP OP
          • NULL: Cloud Hadoop NULL OP
        cloudHadoopInstanceOperation.codeNameString-클러스터 운영 코드 이름
        cloudHadoopInstanceStatusNameString-클러스터 상태 이름
        • creating | running | settingup | deleting
          • creating: 생성 중
          • running: 운영 중
          • settingup: 설정 중
          • deleting: 삭제 중
        publicDnsNameString-공인 도메인
        publicIpString-공인 IP 주소
        isHaBoolean-고가용성 지원 여부
        • true (기본값) | false
          • true: 지원
          • false: 지원 안 함
        zoneObject-존 정보
        zone.zoneNoString-존 번호
        zone.zoneNameString-존 이름
        zone.zoneCodeString-존 코드
        zone.zoneDescriptionString-존 설명
        zone.regionNoString-리전 번호
        regionObject-리전 정보
        region.regionNoString-리전 번호
        region.regionCodeString-리전 코드
        region.regionNameString-리전 이름
        masterNodeServerNameString-마스터노드 서버 이름
        createDateString-클러스터 생성 일시
        • ISO 8601 형식
        dataArchitectureString-데이터 아키텍처
        bucketNameString-Object Storage 버킷 이름
        directConnectionAccountString-클러스터 직접 접속 계정
        loginKeyNameString-인증키 이름
        accessControlGroupListArray-ACG 목록

        accessControlGroupList

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

        필드타입필수 여부설명
        accessControlGroupConfigurationNoString-ACG 아이디
        accessControlGroupNameString-ACG 이름
        accessControlGroupDescriptionString-ACG에 대한 메모
        isDefaultBoolean-기본 ACG 여부
        • true | false
          • true: 기본 ACG
          • false: 기본 ACG 아님
        createDateString-ACG 생성 일시
        • ISO 8601 형식

        응답 상태 코드

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

        응답 예시

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

        {
            "getCloudHadoopInstanceListResponse": {
                "totalRows": 3,
                "cloudHadoopInstanceList": [
                    {
                        "cloudHadoopInstanceNo": "2777****",
                        "cloudHadoopClusterName": "cluster001",
                        "cloudHadoopImageProductCode": "SPSWCHADPLINUX02",
                        "masterNodeCpuCount": 4,
                        "masterNodeCount": 2,
                        "masterNodeMemorySize": 8589934592,
                        "workerNodeCpuCount": 4,
                        "workerNodeCount": 2,
                        "workerNodeMemorySize": 17179869184,
                        "cloudHadoopInstanceStatus": {
                            "code": "INIT",
                            "codeName": "Cloud Hadoop INIT 상태"
                        },
                        "cloudHadoopInstanceStatusName": "creating",
                        "isHa": true,
                        "zone": {
                            "zoneNo": "3",
                            "zoneName": "KR-2",
                            "zoneCode": "KR-2",
                            "zoneDescription": "평촌 zone",
                            "regionNo": "1"
                        },
                        "region": {
                            "regionNo": "1",
                            "regionCode": "KR",
                            "regionName": "Korea"
                        },
                        "masterNodeServerName": "m-001-cluster001-hd",
                        "createDate": "2025-02-28T13:56:45+0900",
                        "dataArchitecture": "OBJST",
                        "bucketName": "nb002",
                        "directConnectionAccount": "sshuser",
                        "loginKeyName": "test-123",
                        "accessControlGroupList": [
                            {
                                "accessControlGroupConfigurationNo": "192****",
                                "accessControlGroupName": "cloud-hadoop-gjcmb",
                                "accessControlGroupDescription": "Group for Cloud Hadoop cluster cluster001 (automatically created)",
                                "isDefault": false,
                                "createDate": "2025-02-28T13:56:47+0900"
                            }
                        ]
                    },
                    {
                        "cloudHadoopInstanceNo": "2777****",
                        "cloudHadoopClusterName": "cluster000",
                        "cloudHadoopImageProductCode": "SPSWCHADPLINUX03",
                        "masterNodeCpuCount": 4,
                        "masterNodeCount": 2,
                        "masterNodeMemorySize": 8589934592,
                        "workerNodeCpuCount": 4,
                        "workerNodeCount": 2,
                        "workerNodeMemorySize": 34359738368,
                        "edgeNodeCpuCount": 4,
                        "edgeNodeCount": 1,
                        "edgeNodeMemorySize": 8589934592,
                        "cloudHadoopInstanceStatusName": "deleting",
                        "publicDnsName": "****.hadoop.ntruss.com",
                        "publicIp": "***.***.***.***",
                        "isHa": true,
                        "zone": {
                            "zoneNo": "3",
                            "zoneName": "KR-2",
                            "zoneCode": "KR-2",
                            "zoneDescription": "평촌 zone",
                            "regionNo": "1"
                        },
                        "region": {
                            "regionNo": "1",
                            "regionCode": "KR",
                            "regionName": "Korea"
                        },
                        "masterNodeServerName": "m-001-cluster000-hd",
                        "createDate": "2025-02-28T13:04:38+0900",
                        "dataArchitecture": "OBJST",
                        "bucketName": "nb001",
                        "directConnectionAccount": "sshuser",
                        "loginKeyName": "test-123",
                        "accessControlGroupList": [
                            {
                                "accessControlGroupConfigurationNo": "192****",
                                "accessControlGroupName": "cloud-hadoop-gjcel",
                                "accessControlGroupDescription": "Group for Cloud Hadoop cluster cluster000 (automatically created)",
                                "isDefault": false,
                                "createDate": "2025-02-28T13:04:40+0900"
                            }
                        ]
                    },
                    {
                        "cloudHadoopInstanceNo": "2777****",
                        "cloudHadoopClusterName": "cluster",
                        "cloudHadoopImageProductCode": "SPSWCHADPLINUX03",
                        "cloudHadoopClusterType": {
                            "code": "CHADP",
                            "codeName": "Core Hadoop"
                        },
                        "masterNodeCpuCount": 4,
                        "masterNodeCount": 2,
                        "masterNodeMemorySize": 8589934592,
                        "workerNodeCpuCount": 4,
                        "workerNodeCount": 22,
                        "workerNodeMemorySize": 34359738368,
                        "edgeNodeCpuCount": 4,
                        "edgeNodeCount": 1,
                        "edgeNodeMemorySize": 8589934592,
                        "cloudHadoopInstanceOperation": {
                            "code": "NULL",
                            "codeName": "Cloud Hadoop NULL OP"
                        },
                        "cloudHadoopInstanceStatusName": "running",
                        "publicDnsName": "****.hadoop.ntruss.com",
                        "publicIp": "***.***.***.***",
                        "isHa": true,
                        "zone": {
                            "zoneNo": "3",
                            "zoneName": "KR-2",
                            "zoneCode": "KR-2",
                            "zoneDescription": "평촌 zone",
                            "regionNo": "1"
                        },
                        "region": {
                            "regionNo": "1",
                            "regionCode": "KR",
                            "regionName": "Korea"
                        },
                        "masterNodeServerName": "m-001-cluster-hd",
                        "createDate": "2025-02-28T09:16:46+0900",
                        "dataArchitecture": "OBJST",
                        "bucketName": "dataforest",
                        "directConnectionAccount": "sshuser",
                        "loginKeyName": "test-123",
                        "accessControlGroupList": [
                            {
                                "accessControlGroupConfigurationNo": "192****",
                                "accessControlGroupName": "cloud-hadoop-gjb5m",
                                "accessControlGroupDescription": "Group for Cloud Hadoop cluster cluster (automatically created)",
                                "isDefault": false,
                                "createDate": "2025-02-28T09:16:48+0900"
                            }
                        ]
                    }
                ],
                "requestId": "af2c44e0-****-****-****-99c9f669ad22",
                "returnCode": "0",
                "returnMessage": "success"
            }
        }
        JSON

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

        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.