getCloudHadoopInstanceList

Prev Next

Classic環境で利用できます。

Cloud Hadoopクラスタリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET | POST /hadoop/v2/getCloudHadoopInstanceList
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Cloud Hadoop APIで共通して使用されるヘッダの詳細は、Cloud Hadoopのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionNo String Optional リージョン番号
zoneNo String Optional ゾーン番号で絞り込み
cloudHadoopInstanceNo String Optional クラスタインスタンス番号で絞り込み
searchFilterName String Optional 検索カラム
  • clusterName: クラスタ名(有効値)
  • searchFilterValueを入力した場合、必ず入力
searchFilterValue String Optional 検索キーワード
  • 検索カラムのオプション(clusterName)と全体が一致しない値を入力した場合、レスポンスに空の値を表示
  • searchFilterNameなしでリクエストする場合、全リストを表示
pageNo Integer Optional ページ番号
  • 0~2147483647 (デフォルト: 0)
pageSize Integer Optional ページの出力数
  • 1~2147483647 (デフォルト: 1)
responseFormatType String Optional レスポンスデータの形式
  • 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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
getCloudHadoopInstanceListResponse Object - レスポンス結果
getCloudHadoopInstanceListResponse.totalRows Integer - レスポンス結果数
getCloudHadoopInstanceListResponse.cloudHadoopInstanceList Array - クラスタリスト
getCloudHadoopInstanceListResponse.requestId String - リクエスト ID
  • UUID形式
getCloudHadoopInstanceListResponse.returnCode String - レスポンスコード
getCloudHadoopInstanceListResponse.returnMessage String - レスポンスメッセージ

getCloudHadoopInstanceListResponse.cloudHadoopInstanceList

getCloudHadoopInstanceListResponse.cloudHadoopInstanceListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
cloudHadoopInstanceNo String - クラスタインスタンス番号
cloudHadoopClusterName String - クラスタ名
cloudHadoopImageProductCode String - クラスタイメージコード
cloudHadoopClusterType Object - クラスタタイプ情報
  • cloudHadoopInstanceStatusNameがrunningまたはsettingupの場合、表示
cloudHadoopClusterType.code String - クラスタタイプコード
  • CHADP | HBASE | SPARK | PRESTO
    • CHADP: Core Hadoop
    • HBASE: HBase
    • SPARK: Spark
    • PRESTO: Presto
cloudHadoopClusterType.codeName String - クラスタタイプのコード名
masterNodeCpuCount Integer - マスターノードの CPU数
masterNodeCount Integer - マスターノード数
masterNodeMemorySize Integer - マスターノードのメモリ容量(Byte)
workerNodeCpuCount Integer - ワーカーノードの CPU数
workerNodeCount Integer - ワーカーノード数
workerNodeMemorySize Integer - ワーカーノードのメモリ容量(Byte)
edgeNodeCpuCount Integer - エッジノードの CPU数
edgeNodeCount Integer - エッジノード数
edgeNodeMemorySize Integer - エッジノードのメモリ容量(Byte)
cloudHadoopInstanceStatus Object - クラスタ状態情報
  • cloudHadoopInstanceStatusNameがcreatingの場合、表示
cloudHadoopInstanceStatus.code String - クラスタの状態コード
  • INIT: Cloud Hadoop INIT状態
cloudHadoopInstanceStatus.codeName String - クラスタ状態コード名
cloudHadoopInstanceOperation Object - クラスタ運用情報
  • cloudHadoopInstanceStatusNameがrunningまたはsettingupの場合、表示
cloudHadoopInstanceOperation.code String - クラスタ運用コード
  • SETUP | NULL
    • SETUP: Cloud Hadoop SETUP OP
    • NULL: Cloud Hadoop NULL OP
cloudHadoopInstanceOperation.codeName String - クラスタ運用コード名
cloudHadoopInstanceStatusName String - クラスタ状態名
  • creating | running | settingup | deleting
    • creating: 作成中
    • running: 運用中
    • settingup: 設定中
    • deleting: 削除中
publicDnsName String - グローバルドメイン
publicIp String - グローバル IPアドレス
isHa Boolean - 高可用性をサポートするかどうか
  • true (デフォルト) | false
    • true: サポート
    • false: サポートしない
zone Object - ゾーン情報
zone.zoneNo String - ゾーン番号
zone.zoneName String - ゾーン名
zone.zoneCode String - ゾーンコード
zone.zoneDescription String - ゾーンの説明
zone.regionNo String - リージョン番号
region Object - リージョン情報
region.regionNo String - リージョン番号
region.regionCode String - リージョンコード
region.regionName String - リージョン名
masterNodeServerName String - マスターノードサーバ名
createDate String - クラスタの作成日時
  • ISO 8601形式
dataArchitecture String - データアーキテクチャ
bucketName String - Object Storageバケット名
directConnectionAccount String - クラスタ直接アクセスアカウント
loginKeyName String - 認証キー名
accessControlGroupList Array - ACGリスト

accessControlGroupList

accessControlGroupListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
accessControlGroupConfigurationNo String - ACG ID
accessControlGroupName String - ACG名
accessControlGroupDescription String - ACGに関するメモ
isDefault Boolean - デフォルト ACGかどうか
  • true | false
    • true: デフォルト ACG
    • false: デフォルト ACGではない
createDate String - 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": "坪村ゾーン",
                    "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": "坪村ゾーン",
                    "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": "坪村ゾーン",
                    "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"
    }
}