get-hadoop-cluster-info

Prev Next

Available in VPC

Get Hadoop cluster information of Data Box.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/data-box/get-hadoop-cluster-info

Request headers

For information about the headers common to all Data Box Frame APIs, see Data Box Frame request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
dataBoxFrameNo Integer Required Data Box Frame number
dataBoxNo Integer Required Data Box number
instanceNo Integer Required Hadoop cluster number
  • See get-data-box-infra-list.
  • The Hadoop edge, Hadoop master, and Hadoop worker node types in the same Data Box have the same instance numbers.

Request example

The request example is as follows:

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-hadoop-cluster-info?dataBoxFrameNo=83&dataBoxNo=381&instanceNo=*********' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
specList Array - Hadoop cluster node information list
connectionList Array - Access information list
storageList Array - NAS storage information list

specList

The following describes specList.

Field Type Required Description
name String - Hadoop cluster node type
spec String - Node server spec name
nodeCount Integer - Number of node servers

connectionList

The following describes connectionList.

Field Type Required Description
applicationName String - Name of the application to connect to
connectionUrl String - Application access URL

storageList

The following describes storageList.

Field Type Required Description
name String - NAS storage name
storagePath String - NAS mount path

Response status codes

For information about the response status codes common to all Data Box Frame APIs, see Data Box Frame API response status codes.

Response example

The response example is as follows:

{
    "specList": [
        {
            "name": "Hadoop Edge",
            "spec": "Hadoop Linux Server (C8-H1 : 8vCPU 16GB Mem)",
            "nodeCount": 1
        },
        {
            "name": "Hadoop Master",
            "spec": "Hadoop Linux Server (C8-H1 : 8vCPU 16GB Mem)",
            "nodeCount": 2
        },
        {
            "name": "Hadoop Worker",
            "spec": "Hadoop Linux Server (C8-H1 : 8vCPU 16GB Mem)",
            "nodeCount": 2
        }
    ],
    "connectionList": [
        {
            "applicationName": "Ambari",
            "connectionUrl": "https://***.***.***.***:8443"
        },
        {
            "applicationName": "Hue",
            "connectionUrl": "https://***.***.***.***:8081"
        },
        {
            "applicationName": "Zeppelin",
            "connectionUrl": "https://***.***.***.***:9996"
        }
    ],
    "storageList": [
        {
            "name": "NAS for export",
            "storagePath": "/mnt/nasw381n1"
        }
    ]
}