クラスタの照会

Prev Next

VPC環境で利用できます。

Cloud Data Streaming Serviceクラスタの詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList/2434156' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.clusterName String - クラスタ名
result.kafkaVersionCode String - Kafkaバージョンコード
result.kafkaManagerUserName String - CMAKアクセスアカウント ID
result.softwareProductCode String - OSタイプコード
result.vpcNo Integer - VPC番号
result.managerNodeProductCode String - マネージャノードのサーバタイプコード
result.managerNodeSubnetNo Integer - マネージャノードの Subnet番号
result.brokerNodeProductCode String - ブローカーノードのサーバタイプコード
result.brokerNodeSubnetNo Integer - ブローカーノードの Subnet番号
result.brokerNodeCount Integer - ブローカーノード数
result.brokerNodeStorageSize Integer - ブローカーノード別ストレージ容量(GB)
result.configGroupNo Integer - Config Group番号
result.status String - クラスタの状態
requestId String - リクエスト ID
  • UUID形式

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "clusterName": "cluster00",
        "kafkaVersionCode": "3903006",
        "kafkaManagerUserName": "userid",
        "softwareProductCode": "SW.VCDSS.OS.LNX64.CNTOS.0708.B050",
        "vpcNo": 4***,
        "managerNodeProductCode": "SVR.VCDSS.STAND.C002.M008.NET.SSD.B050.G002",
        "managerNodeSubnetNo": 33***,
        "brokerNodeProductCode": "SVR.VCDSS.STAND.C002.M008.NET.SSD.B050.G002",
        "brokerNodeSubnetNo": 33***,
        "brokerNodeCount": 3,
        "brokerNodeStorageSize": 100,
        "configGroupNo": 3**,
        "status": "running"
    },
    "requestId": "a0d09046-****-****-****-207abe3cf0bc"
}