getCloudHadoopInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

It can be used in a VPC environment.

Summary

Search a list of Cloud Hadoop instances.

Request

Request parameters

Parameter name	Requirement status	Type	Restrictions	Description
regionCode	No	String		- Region code - You can decide the region where the list of Cloud Hadoop instances will be searched. - You can obtain the regionCode through the getRegionList action. - Default: Select the first region of the getRegionList search results
zoneCode	No	String		- Zone code - You can decide the zone in which the list of Cloud Hadoop instances will be searched. - You can obtain the zoneCode through the getZoneList action.
vpcNo	No	String		- VPC number - You can decide the VPC in which the list of Cloud Hadoop instances will be searched. - You can obtain the vpcNo through the getVpcList action.
subnetNo	No	String		- Subnet number - You can decide the subnet in which the list of Cloud Hadoop instances will be searched. - You can obtain the SubnetNo through the getSubnetList action.
cloudHadoopClusterName	No	String		- cloudHadoopClusterName - You can filter your search with a Cloud Hadoop Cluster name. - You can obtain the cloudHadoopClusterName through the getCloudHadoopInstanceList action.
cloudHadoopInstanceNoList	No	List<String>		- List of Cloud Hadoop instance numbers - You can filter your search with a Cloud Hadoop instance number. - You can obtain the cloudHadoopInstanceNoList through the getCloudHadoopInstanceList action. - ex) cloudHadoopInstanceNoList 1234 2345
cloudHadoopServerName	No	String		- Cloud Hadoop server name - You can filter your search with a Cloud Hadoop server name. - You can obtain the cloudHadoopServerName through the getCloudHadoopInstanceList action.
cloudHadoopServerInstanceNoList	No	List<String>		- List of Cloud Hadoop server instance numbers - You can filter your search with a Cloud Hadoop server instance number. - You can obtain the cloudHadoopServerInstanceNoList through the getCloudHadoopInstanceList action. - ex) cloudHadoopServerInstanceNoList 1234 2345
pageNo	No	Integer	Min: 0	- Page number of the paged results - The results can be paged using pageNo and pageSize.
pageSize	Conditional	Integer	Min: 1	- Each page size to be displayed when paging - The results can be paged using pageNo and pageSize. - Entering this info is required when pageNo is entered.
output	No	String		- Format type for the response results - Options : xml \| json - Default : json

Response

Response data type

CloudHadoopInstanceList type

CloudHadoopInstanceList extends CommonResponse
private Integer totalRows;
private List<CloudHadoopInstance> cloudHadoopInstanceList = new ArrayList<>();

CloudHadoopInstance
private String cloudHadoopInstanceNo;
private String cloudHadoopClusterName;
private String cloudHadoopInstanceStatusName;
private CommonCode cloudHadoopInstanceStatus;
private CommonCode cloudHadoopInstanceOperation;
private CloudHadoopClusterType cloudHadoopClusterType;
private CloudHadoopVersion cloudHadoopVersion;
private List<CloudHadoopAddOn> cloudHadoopAddOnList
private String ambariServerHost;
private String clusterDirectAccessAccount;
private String loginKey;
private String objectStorageBucket;
private String kdcRealm;
private String cloudHadoopImageProductCode;
private Boolean isHa;
private String domain;
private AccessControlGroupNoList accessControlGroupNoList;
private Date createDate;
private Boolean useDataCatalog;
private List<CloudHadoopServerInstance> cloudHadoopServerInstanceList;

CloudHadoopAddOn
private String code;
private String codeName;

CloudHadoopClusterType
private String code;
private String codeName;

CloudHadoopVersion
private String code;
private String codeName;

AccessControlGroupNoList
private List<String> accessControlGroupNoList = new ArrayList<>();

CloudHadoopServerInstance
private String cloudHadoopServerInstanceNo;
private String cloudHadoopServerName;
private String cloudHadoopServerInstanceStatusName;
private CommonCode cloudHadoopServerInstanceStatus;
private CommonCode cloudHadoopServerInstanceOperation;
private CommonCode cloudHadoopServerRole;
private String regionCode;
private String vpcNo;
private String subnetNo;
private Date createDate;
private Date uptime;
private String zoneCode;
private Long memorySize;
private Integer cpuCount;
private Boolean isPublicSubnet;
private Long dataStorageSize;
private String cloudHadoopProductCode;
private CommonCode dataStorageType;

Examples

Request example

ncloud vhadoop getCloudHadoopInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ***87 --subnetNo ***32 --cloudHadoopClusterName test-**** --cloudHadoopInstanceNoList 178**** --cloudHadoopServerName test-**** --cloudHadoopServerInstanceNoList 1781*** --pageNo 0 --pageSize 10

Response example

{
  "getCloudHadoopInstanceListResponse": {
    "totalRows": 1,
    "cloudHadoopInstanceList": [
      {
        "cloudHadoopInstanceNo": "2773990",
        "cloudHadoopClusterName": "dsadsad",
        "cloudHadoopInstanceStatusName": "running",
        "cloudHadoopInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudHadoopInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudHadoopClusterType": {
          "code": "CORE_HADOOP_WITH_SPARK",
          "codeName": "Core Hadoop with Spark : HDFS(3.1.1), YARN(3.1.1), Zookeeper(3.4.9), Ranger(2.0.0), HIVE(3.1.2), Hue(4.8.0), Zeppelin Notebook(0.10.1), Spark (2.4.8)"
        },
        "cloudHadoopVersion": {
          "code": "HADOOP2.0",
          "codeName": "Cloud Hadoop 2.0"
        },
        "cloudHadoopImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDP.20.B050",
        "cloudHadoopServerInstanceList": [
          {
            "cloudHadoopServerInstanceNo": "2773999",
            "cloudHadoopServerName": "e-001-dsadsad-15fd-hd",
            "cloudHadoopServerRole": {
              "code": "E",
              "codeName": "Edge Node"
            },
            "cloudHadoopServerInstanceStatusName": "running",
            "cloudHadoopServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "3977",
            "subnetNo": "5747",
            "dataStorageSize": 107374182400,
            "cpuCount": 8,
            "memorySize": 34359738368
          },
          {
            "cloudHadoopServerInstanceNo": "2773991",
            "cloudHadoopServerName": "m-001-dsadsad-15fb-hd",
            "cloudHadoopServerRole": {
              "code": "M",
              "codeName": "Master Node"
            },
            "cloudHadoopServerInstanceStatusName": "running",
            "cloudHadoopServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "3977",
            "subnetNo": "5747",
            "dataStorageSize": 107374182400,
            "cpuCount": 8,
            "memorySize": 34359738368
          },
          {
            "cloudHadoopServerInstanceNo": "2773995",
            "cloudHadoopServerName": "m-002-dsadsad-15fc-hd",
            "cloudHadoopServerRole": {
              "code": "M",
              "codeName": "Master Node"
            },
            "cloudHadoopServerInstanceStatusName": "running",
            "cloudHadoopServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "3977",
            "subnetNo": "5747",
            "dataStorageSize": 107374182400,
            "cpuCount": 8,
            "memorySize": 34359738368
          },
          {
            "cloudHadoopServerInstanceNo": "2774002",
            "cloudHadoopServerName": "d-001-dsadsad-15fe-hd",
            "cloudHadoopServerRole": {
              "code": "D",
              "codeName": "Date Node"
            },
            "cloudHadoopServerInstanceStatusName": "running",
            "cloudHadoopServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "3977",
            "subnetNo": "5747",
            "dataStorageSize": 107374182400,
            "cpuCount": 8,
            "memorySize": 34359738368
          },
          {
            "cloudHadoopServerInstanceNo": "2774006",
            "cloudHadoopServerName": "d-002-dsadsad-15ff-hd",
            "cloudHadoopServerRole": {
              "code": "D",
              "codeName": "Date Node"
            },
            "cloudHadoopServerInstanceStatusName": "running",
            "cloudHadoopServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "3977",
            "subnetNo": "5747",
            "dataStorageSize": 107374182400,
            "cpuCount": 8,
            "memorySize": 34359738368
          },
          {
            "cloudHadoopServerInstanceNo": "2775743",
            "cloudHadoopServerName": "d-003-dsadsad-15ir-hd",
            "cloudHadoopServerRole": {
              "code": "D",
              "codeName": "Date Node"
            },
            "cloudHadoopServerInstanceStatusName": "running",
            "cloudHadoopServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "3977",
            "subnetNo": "5747",
            "dataStorageSize": 107374182400,
            "cpuCount": 8,
            "memorySize": 34359738368
          }
        ]
      }
    ],
    "requestId": "dfb64c78-5b94-44b1-8514-e5d14158b46b",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

<getCloudHadoopInstanceListResponse>
    <requestId>74dd4dd4-9fa3-49a9-b001-86cfd2931a4a</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudHadoopInstanceList>
        <cloudHadoopInstance>
            <cloudHadoopInstanceNo>1912200</cloudHadoopInstanceNo>
            <cloudHadoopClusterName>fasdasd</cloudHadoopClusterName>
            <cloudHadoopInstanceStatusName>running</cloudHadoopInstanceStatusName>
            <cloudHadoopInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created State</codeName>
            </cloudHadoopInstanceStatus>
            <cloudHadoopInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudHadoopInstanceOperation>
            <cloudHadoopClusterType>
                <code>CORE_HADOOP_WITH_SPARK</code>
                <codeName>Core Hadoop with Spark : HDFS(3.1.1), YARN(3.1.1), Zookeeper(3.4.6), Ranger(1.2.0), HIVE(3.1.0), Hue(4.3.0), Zepplin Notebook(0.8.0), Spark(2.3.2)</codeName>
            </cloudHadoopClusterType>
            <cloudHadoopVersion>
                <code>HADOOP1.5</code>
                <codeName>Cloud Hadoop 1.5</codeName>
            </cloudHadoopVersion>
            <cloudHadoopImageProductCode>SW.VCHDP.LNX64.CNTOS.0708.HDP.15.B050</cloudHadoopImageProductCode>
            <cloudHadoopServerInstanceList>
                <cloudHadoopServerInstance>
                    <cloudHadoopServerInstanceNo>****</cloudHadoopServerInstanceNo>
                    <cloudHadoopServerName>****</cloudHadoopServerName>
                    <cloudHadoopServerRole>
                        <code>D</code>
                        <codeName>Date Node</codeName>
                    </cloudHadoopServerRole>
                    <cloudHadoopServerInstanceStatusName>running</cloudHadoopServerInstanceStatusName>
                    <cloudHadoopServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudHadoopServerInstanceStatus>
                    <cloudHadoopServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudHadoopServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>**65</vpcNo>
                    <subnetNo>**23</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>4</cpuCount>
                    <memorySize>34359738368</memorySize>
                </cloudHadoopServerInstance>
                <cloudHadoopServerInstance>
                    <cloudHadoopServerInstanceNo>****</cloudHadoopServerInstanceNo>
                    <cloudHadoopServerName>****</cloudHadoopServerName>
                    <cloudHadoopServerRole>
                        <code>D</code>
                        <codeName>Date Node</codeName>
                    </cloudHadoopServerRole>
                    <cloudHadoopServerInstanceStatusName>running</cloudHadoopServerInstanceStatusName>
                    <cloudHadoopServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudHadoopServerInstanceStatus>
                    <cloudHadoopServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudHadoopServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>**65</vpcNo>
                    <subnetNo>**23</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>4</cpuCount>
                    <memorySize>34359738368</memorySize>
                </cloudHadoopServerInstance>
                <cloudHadoopServerInstance>
                    <cloudHadoopServerInstanceNo>****</cloudHadoopServerInstanceNo>
                    <cloudHadoopServerName>****</cloudHadoopServerName>
                    <cloudHadoopServerRole>
                        <code>E</code>
                        <codeName>Edge Node</codeName>
                    </cloudHadoopServerRole>
                    <cloudHadoopServerInstanceStatusName>running</cloudHadoopServerInstanceStatusName>
                    <cloudHadoopServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudHadoopServerInstanceStatus>
                    <cloudHadoopServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudHadoopServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>1665</vpcNo>
                    <subnetNo>2020</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>4</cpuCount>
                    <memorySize>34359738368</memorySize>
                </cloudHadoopServerInstance>
                <cloudHadoopServerInstance>
                    <cloudHadoopServerInstanceNo>****</cloudHadoopServerInstanceNo>
                    <cloudHadoopServerName>****</cloudHadoopServerName>
                    <cloudHadoopServerRole>
                        <code>M</code>
                        <codeName>Master Node</codeName>
                    </cloudHadoopServerRole>
                    <cloudHadoopServerInstanceStatusName>running</cloudHadoopServerInstanceStatusName>
                    <cloudHadoopServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudHadoopServerInstanceStatus>
                    <cloudHadoopServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudHadoopServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>1665</vpcNo>
                    <subnetNo>2020</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>8</cpuCount>
                    <memorySize>34359738368</memorySize>
                </cloudHadoopServerInstance>
                <cloudHadoopServerInstance>
                    <cloudHadoopServerInstanceNo>****</cloudHadoopServerInstanceNo>
                    <cloudHadoopServerName>****</cloudHadoopServerName>
                    <cloudHadoopServerRole>
                        <code>M</code>
                        <codeName>Master Node</codeName>
                    </cloudHadoopServerRole>
                    <cloudHadoopServerInstanceStatusName>running</cloudHadoopServerInstanceStatusName>
                    <cloudHadoopServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudHadoopServerInstanceStatus>
                    <cloudHadoopServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudHadoopServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>1665</vpcNo>
                    <subnetNo>2020</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>8</cpuCount>
                    <memorySize>34359738368</memorySize>
                </cloudHadoopServerInstance>
            </cloudHadoopServerInstanceList>
        </cloudHadoopInstance>
    </cloudHadoopInstanceList>
</getCloudHadoopInstanceListResponse>

Was this article helpful?

What's Next

getCloudHadoopLoginKeyList

Table of contents

Summary
Request
Response
Examples