getCloudHadoopInstanceList

We are preparing a localization service for the content. We will do our best to provide the localization service as soon as possible.

Overview

Gets Cloud Hadoop cluster list information.

Request

Request Parameters

Request Header

Refer to Cloud Hadoop API Guide

Response

Success

{
    "getCloudHadoopInstanceListResponse": {
        "requestId": "<api-call-request-id>",
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": <response-list-length>,
        "cloudHadoopInstanceList": [
            {
                "cloudHadoopInstanceNo": "<cluster-id>",
                "cloudHadoopClusterName": "<cluster-name>",
                "cloudHadoopImageProductCode": "<image-code-installed-in-cluster>",
                "cloudHadoopClusterType": {
                    "code": "<cluster-type-code>",
                    "codeName": "<cluster-type-name>"
                },
                "masterNodeCpuCount": <masternode-cpu-count>,
                "masterNodeCount": <masternode-instance-count>,
                "masterNodeMemorySize": <masternode-memory(Byte)>,
                "workerNodeCpuCount": <workernode-cpu-count>,
                "workerNodeCount": <workernode-instance-count>,
                "workerNodeMemorySize": <workernode-memory(Byte)>,
                "cloudHadoopInstanceOperation": {
                    "code": "<cluster-work-code>",
                    "codeName": "<cluster-work-name>"
                },
                "cloudHadoopInstanceStatus": {
                    "code": "<cluster-status-code>",
                    "codeName": "<cluster-status-name>"
                },
                "cloudHadoopInstanceStatusName": "<cluster-status-name>",
                "publicDnsName": "<public-domain-name>",
                "publicIp": "<public-ip>",
                "isHa": <whether-HA-is-enabled>,
                "zone": {
                    "zoneNo": "<Zone-id>",
                    "zoneName": "<Zone-name>",
                    "zoneCode": "<Zone-code>",
                    "zoneDescription": "<Zone-description>",
                    "regionNo": "<Region-id>"
                },
                "region": {
                    "regionNo": "<Region-id>",
                    "regionCode": "<Region-code>",
                    "regionName": "<Region-name>"
                },
                "masterNodeServerName": "",
                "createDate": "<creation-date>",
                "dataArchitecture": "<",
                "bucketName": "<object-storage-name>",
                "directConnectionAccount": "<server-access-account>",
                "loginKeyName": "<login-pem-key-name>",
                "accessControlGroupList": [
                    {
                        "accessControlGroupConfigurationNo": "<ACG-id>",
                        "accessControlGroupName": "<ACG-name>",
                        "accessControlGroupDescription": "<ACG-description>",
                        "isDefault": <whether-it-is-default-ACG>,
                        "createDate": "<ACG-creation-time>"
                    }
                ]
            }
        ]
    }
}

Authentication failed

{
    "error": {
        "errorCode": "<return-code>",
        "message": "<return-message>"
    }
}

Bad parameter

{
    "responseError": {
        "returnCode": "<return-code>",
        "returnMessage": "<return-message>"
    }
}

Examples

Request Example

curl -i -X GET \
   -H "x-ncp-apigw-timestamp:1505290625682" \
   -H "x-ncp-iam-access-key:D78BB444D6D3C84CA38A" \
   -H "x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=" \
   "https://ncloud.apigw.ntruss.com/hadoop/v2/getCloudHadoopInstanceListResponse"

Request Example

{
    "getCloudHadoopInstanceListResponse": {
        "requestId": "ab1f3d79-5387-4987-ad18-a15ccf776a98",
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": 1,
        "cloudHadoopInstanceList": [
            {
                "cloudHadoopInstanceNo": "1068952",
                "cloudHadoopClusterName": "cluster-01",
                "cloudHadoopImageProductCode": "SPSWCHADPLINUX01",
                "cloudHadoopClusterType": {
                    "code": "CHADP",
                    "codeName": "Core Hadoop"
                },
                "masterNodeCpuCount": 4,
                "masterNodeCount": 2,
                "masterNodeMemorySize": 8589934592,
                "workerNodeCpuCount": 4,
                "workerNodeCount": 3,
                "workerNodeMemorySize": 8589934592,
                "cloudHadoopInstanceOperation": {
                    "code": "NULL",
                    "codeName": "Cloud Hadoop NULL OP"
                },
                "cloudHadoopInstanceStatus": {
                    "code": "CREAT",
                    "codeName": "Cloud Hadoop CREATE State"
                },
                "cloudHadoopInstanceStatusName": "running",
                "publicDnsName": "pub-10jso.hadoop.ntruss.com",
                "publicIp": "106.10.33.112",
                "isHa": true,
                "zone": {
                    "zoneNo": "3",
                    "zoneName": "KR-2",
                    "zoneCode": "KR-2",
                    "zoneDescription": "\ud3c9\ucd0c zone",
                    "regionNo": "1"
                },
                "region": {
                    "regionNo": "1",
                    "regionCode": "KR",
                    "regionName": "Korea"
                },
                "masterNodeServerName": "m-001-cluster-01-hd",
                "createDate": "2018-11-16T16:54:37+0900",
                "dataArchitecture": "Object Storage",
                "bucketName": "user-bucket",
                "directConnectionAccount": "sshuser",
                "loginKeyName": "user-dev-key",
                "accessControlGroupList": [
                    {
                        "accessControlGroupConfigurationNo": "68867",
                        "accessControlGroupName": "cloud-hadoop-mwt4",
                        "accessControlGroupDescription": "Group for Cloud Hadoop cluster 'api-test' (automatically created)",
                        "isDefault": false,
                        "createDate": "2018-11-16T16:54:38+0900"
                    }
                ]
            }
        ]
    }
}