getCloudHadoopInstanceList

Prev Next

VPC環境で利用できます。

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

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
zoneCode String Optional ゾーンコードで絞り込み
vpcNo String Optional VPC番号で絞り込み
subnetNo String Optional Subnet番号で絞り込み
cloudHadoopClusterName String Optional クラスタ名で絞り込み
cloudHadoopInstanceNoList Array Optional クラスタインスタンス番号リスト
  • クラスタインスタンス番号で絞り込み
  • <例> cloudHadoopInstanceNoList.1=1234&cloudHadoopInstanceNoList.2=2345
cloudHadoopServerName String Optional サーバ名で絞り込み
cloudHadoopServerInstanceNoList Array Optional サーバインスタンス番号リスト
  • サーバインスタンス番号で絞り込み
  • <例> cloudHadoopServerInstanceNoList.1=1234&cloudHadoopServerInstanceNoList.2=2345
pageNo Integer Optional ページ番号
  • 0~N (デフォルト: 0)
pageSize Integer Optional ページの出力数
  • 1~N (デフォルト: 1)
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vhadoop/v2/getCloudHadoopInstanceList?regionCode=KR&vpcNo=7****&subnetNo=17****&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}'

レスポンス

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

レスポンスボディ

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

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

レスポンスステータスコード

Cloud Hadoop APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Hadoopのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "getCloudHadoopInstanceListResponse": {
        "totalRows": 1,
        "cloudHadoopInstanceList": [
            {
                "cloudHadoopInstanceNo": "2707****",
                "cloudHadoopClusterName": "clus1",
                "cloudHadoopInstanceStatusName": "running",
                "cloudHadoopInstanceStatus": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Created状態"
                },
                "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.1",
                    "codeName": "Cloud Hadoop 2.1"
                },
                "cloudHadoopImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDP.21.B050",
                "cloudHadoopServerInstanceList": [
                    {
                        "cloudHadoopServerInstanceNo": "2707****",
                        "cloudHadoopServerName": "e-001-clus1-5u29-hd",
                        "cloudHadoopServerRole": {
                            "code": "E",
                            "codeName": "Edge Node"
                        },
                        "cloudHadoopServerInstanceStatusName": "running",
                        "cloudHadoopServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudHadoopServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "vpcName": "****",
                        "subnetNo": "17****",
                        "subnetName": "****",
                        "privateIp": "***.***.***.***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 8,
                        "memorySize": 17179869184
                    },
                    {
                        "cloudHadoopServerInstanceNo": "2707****",
                        "cloudHadoopServerName": "m-001-clus1-5u27-hd",
                        "cloudHadoopServerRole": {
                            "code": "M",
                            "codeName": "Master Node"
                        },
                        "cloudHadoopServerInstanceStatusName": "running",
                        "cloudHadoopServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudHadoopServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "vpcName": "****",
                        "subnetNo": "17****",
                        "subnetName": "****",
                        "privateIp": "***.***.***.***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 4,
                        "memorySize": 17179869184
                    },
                    {
                        "cloudHadoopServerInstanceNo": "2707****",
                        "cloudHadoopServerName": "m-002-clus1-5u28-hd",
                        "cloudHadoopServerRole": {
                            "code": "M",
                            "codeName": "Master Node"
                        },
                        "cloudHadoopServerInstanceStatusName": "running",
                        "cloudHadoopServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudHadoopServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "vpcName": "****",
                        "subnetNo": "17****",
                        "subnetName": "****",
                        "privateIp": "***.***.***.***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 4,
                        "memorySize": 17179869184
                    },
                    {
                        "cloudHadoopServerInstanceNo": "2707****",
                        "cloudHadoopServerName": "d-001-clus1-5u2a-hd",
                        "cloudHadoopServerRole": {
                            "code": "D",
                            "codeName": "Date Node"
                        },
                        "cloudHadoopServerInstanceStatusName": "running",
                        "cloudHadoopServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudHadoopServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "vpcName": "****",
                        "subnetNo": "17****",
                        "subnetName": "****",
                        "privateIp": "***.***.***.***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 4,
                        "memorySize": 17179869184
                    },
                    {
                        "cloudHadoopServerInstanceNo": "2707****",
                        "cloudHadoopServerName": "d-002-clus1-5u2b-hd",
                        "cloudHadoopServerRole": {
                            "code": "D",
                            "codeName": "Date Node"
                        },
                        "cloudHadoopServerInstanceStatusName": "running",
                        "cloudHadoopServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
                        },
                        "cloudHadoopServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "vpcName": "****",
                        "subnetNo": "17****",
                        "subnetName": "****",
                        "privateIp": "***.***.***.***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 4,
                        "memorySize": 17179869184
                    }
                ]
            }
        ],
        "requestId": "8eb61b67-****-****-****-cac06da0d8d2",
        "returnCode": "0",
        "returnMessage": "success"
    }
}