ノードリストの照会

Prev Next

VPC環境で利用できます。

Cloud Data Streaming Serviceクラスタのノードリストを照会します。

リクエスト

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

メソッド URI
GET /api/v1/cluster/getClusterNodeList/{serviceGroupInstanceNo} (韓国リージョン)
GET /api/sgn-v1/cluster/getClusterNodeList/{serviceGroupInstanceNo} (シンガポールリージョン)
GET /api/jpn-v1/cluster/getClusterNodeList/{serviceGroupInstanceNo} (日本リージョン)

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo Integer Required クラスタインスタンス番号

リクエスト例

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

curl --location --request GET 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterNodeList/1009*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.contractNo Integer - 契約番号
result.createdDate Object - クラスタの作成日時
result.createdDate.formattedDate String - クラスタの作成日
  • yyyy-MM-dd形式
result.createdDate.formattedDateTime String - クラスタの作成日時
  • yyyy-MM-dd HH:mm:ss SSSSSS形式
result.createdDate.utc Integer - クラスタの作成日時(ミリ秒)
  • Unix Timestamp形式
result.productCode String - OSタイプコード
result.regionNo Integer - リージョン番号
result.serviceGroupInstanceNo Integer - クラスタインスタンス番号
result.serviceGroupInstanceTypeCode String - クラスタインスタンスタイプ
result.serviceGroupName String - クラスタ名
result.statusCode String - クラスタの状態
result.vpcNo Integer - VPC番号
result.computeList Array - ノードリスト
requestId String - リクエスト ID
  • UUID形式

computeList

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

フィールド タイプ 必須の有無 説明
computeInstanceNo Integer - ノードのサーバインスタンス番号
computeInstanceProductCode String - ノードのサーバタイプコード
computeInstanceStatus String - ノードサーバの状態
cpuCount Integer - CPU数
createdYmdt Object - ノードの作成日時
createdYmdt.formattedDate String - ノードの作成日
  • yyyy-MM-dd形式
createdYmdt.formattedDateTime String - ノードの作成日時
  • yyyy-MM-dd HH:mm:ss SSSSSS形式
createdYmdt.utc Integer - ノードの作成日時(ミリ秒)
  • Unix Timestamp形式
hostName String - ノードサーバ名
macAddress String - ノードサーバの MACアドレス
memorySize Integer - ノードサーバのメモリ容量(Byte)
nodeRoleCode String - ノードタイプコード
  • M | B
    • M: マネージャノード
    • B: ブローカーノード
operationYmdt Object - サーバの作動日時
operationYmdt.formattedDate String - サーバの作動日
  • yyyy-MM-dd形式
operationYmdt.formattedDateTime String - サーバの作動日時
  • yyyy-MM-dd HH:mm:ss SSSSSS形式
operationYmdt.utc Integer - サーバの作動日時(ミリ秒)
  • Unix Timestamp形式
osInfo String - OSのバージョン
privateIp String - ノードサーバの内部 IPアドレス
regionCode String - リージョンコード
regionName String - リージョン名
regionNo String - リージョン番号
serviceGroupInstanceNo Integer - クラスタインスタンス番号
uuid String - ノードサーバ ID
  • UUID形式
vpcName String - VPC名
vpcNo Integer - VPC番号
subnetNo Integer - Subnet番号
subnetName String - Subnet名
zoneName String - ゾーン名
zoneNo Integer - ゾーン番号

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "contractNo": 2982021,
        "createdDate": {
            "formattedDate": "2025-04-16",
            "formattedDateTime": "2025-04-16 09:37:24 000578",
            "utc": 1744763844578
        },
        "productCode": "SW.VCDSS.OS.LNX64.CNTOS.0708.B050",
        "regionNo": 1,
        "serviceGroupInstanceNo": 1009*****,
        "serviceGroupInstanceTypeCode": "DATA_STREAMING_SERVICE",
        "serviceGroupName": "cluster00",
        "statusCode": "CREAT",
        "vpcNo": 4***,
        "computeList": [
            {
                "computeInstanceNo": 1009*****,
                "computeInstanceProductCode": "SVR.VCDSS.STAND.C002.M008.NET.SSD.B050.G002",
                "computeInstanceStatus": "running",
                "cpuCount": 2,
                "createdYmdt": {
                    "formattedDate": "2025-04-16",
                    "formattedDateTime": "2025-04-16 09:37:25 000614",
                    "utc": 1744763845614
                },
                "hostName": "cluster00-m-25t5",
                "macAddress": "F2:20:AF:8A:A6:B3",
                "memorySize": 8589934592,
                "nodeRoleCode": "M",
                "operationYmdt": {
                    "formattedDate": "2025-04-16",
                    "formattedDateTime": "2025-04-16 09:42:13 000750",
                    "utc": 1744764133750
                },
                "osInfo": "CentOS 7.8 (64-bit)",
                "privateIp": "10.0.20.6",
                "regionCode": "KR",
                "regionName": "Korea",
                "regionNo": "1",
                "serviceGroupInstanceNo": 1009*****,
                "uuid": "df2f8b3c-17f0-e12b-b516-7c295a25b34b",
                "vpcName": "test-vpc2",
                "vpcNo": 4***,
                "subnetNo": 33***,
                "subnetName": "sb2 | KR-2 | Private",
                "zoneName": "KR-2",
                "zoneNo": 3
            },
            ...
        ]
    },
    "requestId": "879879dc-****-****-****-649b807afe5a"
}