getCloudHadoopInstanceList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

概要

CloudHadoopクラスタのリスト情報を照会します。

リクエスト

リクエストパラメータ

API Parameter Name	Parameter説明	必須	Default Value	Available Values	Data Type
cloudHadoopInstanceNo	cloudHadoopクラスタ番号	N			String
pageNo	件数が多い場合、ページサイズに該当するページ番号	N		MIN : 0, MAX : 2147483647	Integer
pageSize	1ページで照会するページサイズ	N		MIN : 0, MAX : 2147483647	Integer
searchFilterName	照会するCloudHadoopのフィルタリングする名称(クラスタ名称)	N			String
searchFilterValue	照会するCloudHadoopのフィルタリングする値	N			String
zoneNo	zone番号	N			String
regionNo	region番号	N			String
responseFormatType	responseの結果format設定	N	xml	xml, json	String

リクエストヘッダ

共通ガイド参照

レスポンス

Success

{
    "getCloudHadoopInstanceListResponse": {
        "requestId": "<api-call-request-id>",
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": <response-リスト-長さ>,
        "cloudHadoopInstanceList": [
            {
                "cloudHadoopInstanceNo": "<クラスタ-id>",
                "cloudHadoopClusterName": "<クラスタ-名称>",
                "cloudHadoopImageProductCode": "<クラスタに-設置された-イメージ-コード>",
                "cloudHadoopClusterType": {
                    "code": "<クラスタ-タイプ-コード>",
                    "codeName": "<クラスタ-タイプ-名称>"
                },
                "masterNodeCpuCount": <マスターノード-cpu-数>,
                "masterNodeCount": <マスターノード-インスタンス-数>,
                "masterNodeMemorySize": <マスターノード-メモリ(Byte)>,
                "workerNodeCpuCount": <ワーカーノード-cpu-数>,
                "workerNodeCount": <ワーカーノード-インスタンス-数>,
                "workerNodeMemorySize": <ワーカーノード-メモリ(Byte)>,
                "cloudHadoopInstanceOperation": {
                    "code": "<クラスタ-作業-コード>",
                    "codeName": "<クラスタ-作業-名称>"
                },
                "cloudHadoopInstanceStatus": {
                    "code": "<クラスタ-ステータス-コード>",
                    "codeName": "<クラスタ-ステータス-名称>"
                },
                "cloudHadoopInstanceStatusName": "<クラスタ-ステータス-名称>",
                "publicDnsName": "<グローバル-domain-name>",
                "publicIp": "<グローバル-ip>",
                "isHa": <HA構成-区分>,
                "zone": {
                    "zoneNo": "<Zone-id>",
                    "zoneName": "<Zone-名称>",
                    "zoneCode": "<Zone-コード>",
                    "zoneDescription": "<Zone-説明>",
                    "regionNo": "<Region-id>"
                },
                "region": {
                    "regionNo": "<Region-id>",
                    "regionCode": "<Region-コード>",
                    "regionName": "<Region-名称>"
                },
                "masterNodeServerName": "",
                "createDate": "<作成-日付>",
                "dataArchitecture": "<",
                "bucketName": "<object-storage-名称>",
                "directConnectionAccount": "<サーバ-接続-アカウント>",
                "loginKeyName": "<認証-pem-キー-名称>",
                "accessControlGroupList": [
                    {
                        "accessControlGroupConfigurationNo": "<ACG-id>",
                        "accessControlGroupName": "<ACG-名称>",
                        "accessControlGroupDescription": "<ACG-説明>",
                        "isDefault": <ユーザー-default-ACG-区分>,
                        "createDate": "<ACG-作成-時刻>"
                    }
                ]
            }
        ]
    }
}

Authentication failed

{
    "error": {
        "errorCode": "<リターン-コード>",
        "message": "<リターン-メッセージ>"
    }
}

Bad Parameter

{
    "responseError": {
        "returnCode": "<リターン-コード>",
        "returnMessage": "<リターン-メッセージ>"
    }
}

例示

リクエスト例示

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"

レスポンス例示

{
    "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"
                    }
                ]
            }
        ]
    }
}

この記事は役に立ちましたか?

What's Next

getCloudHadoopProductList

概要
リクエスト
レスポンス
例示

タグ

Cloud Hadoop