VPC環境で利用できます。
Cloud Hadoopクラスタの詳細情報を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | POST | /vhadoop/v2/getCloudHadoopInstanceDetail |
参考
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
リクエストヘッダ
Cloud Hadoop APIで共通して使用されるヘッダの詳細は、Cloud Hadoopのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionCode |
String | Optional | リージョンコード
|
cloudHadoopInstanceNo |
String | Required | クラスタインスタンス番号 |
responseFormatType |
String | Optional | レスポンスデータの形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vhadoop/v2/getCloudHadoopInstanceDetail?regionCode=KR&cloudHadoopInstanceNo=2707*****&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}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
getCloudHadoopInstanceDetailResponse |
Object | - | レスポンスの結果 |
getCloudHadoopInstanceDetailResponse.requestId |
String | - | リクエスト ID
|
getCloudHadoopInstanceDetailResponse.returnCode |
String | - | レスポンスコード |
getCloudHadoopInstanceDetailResponse.returnMessage |
String | - | レスポンスメッセージ |
レスポンスステータスコード
Cloud Hadoop APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Hadoopのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"getCloudHadoopInstanceDetailResponse": {
"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"
},
"cloudHadoopAddOnList": [],
"ambariServerHost": "e-001-clus1-5u29-hd",
"clusterDirectAccessAccount": "sshuser",
"loginKey": "**********",
"objectStorageBucket": "bk1",
"cloudHadoopImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDP.21.B050",
"isHa": true,
"createDate": "2025-02-18T13:35:02+0900",
"domain": "pub-*****.hadoop.ntruss.com",
"useDataCatalog": false,
"accessControlGroupNoList": [
"20****"
],
"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"
},
"cloudHadoopProductCode": "SVR.VCHDP.EDGND.HICPU.C008.M016.NET.HDD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "7****",
"vpcName": "****",
"subnetNo": "17****",
"subnetName": "****",
"privateIp": "***.***.***.***",
"isPublicSubnet": true,
"dataStorageSize": 107374182400,
"cpuCount": 8,
"memorySize": 17179869184,
"uptime": "2025-02-18T13:39:22+0900",
"createDate": "2025-02-18T13:35:02+0900"
},
{
"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"
},
"cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "7****",
"vpcName": "****",
"subnetNo": "17****",
"subnetName": "****",
"privateIp": "***.***.***.***",
"isPublicSubnet": false,
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"dataStorageSize": 107374182400,
"cpuCount": 4,
"memorySize": 17179869184,
"uptime": "2025-02-18T13:40:24+0900",
"createDate": "2025-02-18T13:35:02+0900"
},
{
"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"
},
"cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "7****",
"vpcName": "****",
"subnetNo": "17****",
"subnetName": "****",
"privateIp": "***.***.***.***",
"isPublicSubnet": false,
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"dataStorageSize": 107374182400,
"cpuCount": 4,
"memorySize": 17179869184,
"uptime": "2025-02-18T13:39:23+0900",
"createDate": "2025-02-18T13:35:02+0900"
},
{
"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"
},
"cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "7****",
"vpcName": "****",
"subnetNo": "17****",
"subnetName": "****",
"privateIp": "***.***.***.***",
"isPublicSubnet": false,
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"dataStorageSize": 107374182400,
"cpuCount": 4,
"memorySize": 17179869184,
"uptime": "2025-02-18T13:40:03+0900",
"createDate": "2025-02-18T13:35:02+0900"
},
{
"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"
},
"cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "7****",
"vpcName": "****",
"subnetNo": "17****",
"subnetName": "****",
"privateIp": "***.***.***.***",
"isPublicSubnet": false,
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"dataStorageSize": 107374182400,
"cpuCount": 4,
"memorySize": 17179869184,
"uptime": "2025-02-18T13:40:14+0900",
"createDate": "2025-02-18T13:35:02+0900"
},
{
"cloudHadoopServerInstanceNo": "2707****",
"cloudHadoopServerName": "d-003-clus1-5u3q-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"
},
"cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "7****",
"vpcName": "****",
"subnetNo": "17****",
"subnetName": "****",
"privateIp": "***.***.***.***",
"isPublicSubnet": false,
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"dataStorageSize": 107374182400,
"cpuCount": 4,
"memorySize": 17179869184,
"uptime": "2025-02-18T13:40:14+0900",
"createDate": "2025-02-18T13:35:02+0900"
}
]
}
],
"requestId": "04599c80-****-****-****-363103f13628",
"returnCode": "0",
"returnMessage": "success"
}
}