クラスタリストの照会

Prev Next

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
inputText String Optional 検索キーワード
  • クラスタ名が完全一致または一部一致する値を絞り込み
vpcName String Optional VPC名
  • 完全一致する値のみ絞り込み
pageNo Integer Optional ページ番号
  • 1~N (デフォルト: 1)
pageSize Integer Optional ページの出力数
  • 1~N (デフォルト: 10)

リクエスト例

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList' \
--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' \
--data '{
  "inputText" : "c",
  "vpcName": "test-vpc2",
  "pageNo" : 1,
  "pageSize" : 10
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.currentPage Integer - 現在のページ番号
result.isFirst Boolean - 最初のページかどうか
  • true | false
    • true: 最初のページ
    • false: 最初のページではない
result.isLast Boolean - 最後のページかどうか
  • true | false
    • true: 最後のページ
    • false: 最後のページではない
result.pageSize Integer - ページ表示数
result.totalCount Integer - レスポンス結果数
result.totalPage Integer - ページの総数
result.allowedClusters Array - クラスタリスト
result.disallowedClusters Array - 権限のないクラスタリスト
  • サブアカウントで呼び出す場合、getClusterDetail権限が適用されないクラスタを表示
requestId String - リクエスト ID
  • UUID形式

allowedClusters

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

フィールド タイプ 必須の有無 説明
clusterName String - クラスタ名
brokerNodeType String - ブローカーノードタイプ
brokerNodeProductName String - ブローカーノードのサーバタイプ名
brokerNodeCount Integer - ブローカーノード数
brokerNodePublicEndpoint String - ブローカーノードの Public Endpoint
  • Public Endpointが有効化している場合、有効値を表示
isUsePublicEndpoint Boolean - ブローカーノードの Public Endpointを有効化するかどうか
serverStatus String - サーバの状態
applicationVersion String - Cloud Data Streaming Serviceバージョン
kafkaVersion String - Kafkaバージョン
cmakVersion String - CMAKバージョン
softwareProductName String - OSのバージョン
createDate Date - クラスタの作成日時
managerNodeType String - マネージャノードタイプ
managerNodeCount Integer - マネージャノード数
clusterPublicDomain String - 管理ツールアクセス用 Publicドメイン
isUsePublicDomain Boolean - Publicドメインを有効化するかどうか
brokerStorageVolumeSize Long - ブローカーノードのストレージ容量(GB)
managerNodeAccessControlGroupSequence Integer - マネージャノードの ACG ID
managerNodeAccessControlGroupName String - マネージャノードの ACG名
brokerNodeAccessControlGroupSequence Integer - ブローカーノードの ACG ID
brokerNodeAccessControlGroupName String - ブローカーノードの ACG名
kafkaBrokerPort Integer - ブローカーノードのポート番号
kafkaBrokerTlsPort Integer - ブローカーノードの TLSポート番号
zookeeperPort Integer - ZooKeeperノードのポート番号
cmakPort Integer - CMAKアクセスポート番号
serviceGroupInstanceNo String - クラスタインスタンス番号
kafkaManagerUserName String - CMAKアクセスアカウント ID
memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
vpcName String - VPC名
vpcNo Integer - VPC番号
managerNodeSubnetName String - マネージャノード Subnet名
managerNodeSubnetNo Integer - マネージャノードの Subnet番号
brokerNodeSubnetName String - ブローカーノードの Subnet名
brokerNodeSubnetNo Integer - ブローカーノードの Subnet番号
configGroupNo Integer - Config Group番号
configGroupName String - Config Group名

disallowedClusters

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

フィールド タイプ 必須の有無 説明
clusterName String - クラスタ名
serviceGroupInstanceNo String - クラスタインスタンス番号

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 10,
        "totalCount": 2,
        "totalPage": 1,
        "allowedClusters": [
            {
                "clusterName": "cluster00",
                "brokerNodeType": "[STAND] 2vCPU, 8GB Mem",
                "brokerNodeProductName": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "brokerNodeCount": 3,
                "brokerNodePublicEndpoint": null,
                "isUsePublicEndpoint": false,
                "serverStatus": "running",
                "applicationVersion": "Kafka 3.9.0, CMAK 3.0.0.6",
                "kafkaVersion": "3.9.0",
                "cmakVersion": "3.0.0.6",
                "softwareProductName": "CentOS 7.8 (64-bit)",
                "createDate": "2025-04-16 09:37:24",
                "managerNodeType": "[STAND] 2vCPU, 8GB Mem",
                "managerNodeCount": 1,
                "clusterPublicDomain": "****************************************",
                "isUsePublicDomain": false,
                "brokerStorageVolumeSize": 322122547200,
                "managerNodeAccessControlGroupSequence": 5****,
                "managerNodeAccessControlGroupName": "cdss-m-1o2xag",
                "brokerNodeAccessControlGroupSequence": 5****,
                "brokerNodeAccessControlGroupName": "cdss-b-1o2xag",
                "kafkaBrokerPort": 9092,
                "kafkaBrokerTlsPort": 9093,
                "zookeeperPort": 2181,
                "cmakPort": 9000,
                "serviceGroupInstanceNo": "1009*****",
                "kafkaManagerUserName": "userid",
                "memberNo": "500****",
                "vpcName": "test-vpc2",
                "vpcNo": 4***,
                "managerNodeSubnetName": "sb2 | KR-2 | Private",
                "managerNodeSubnetNo": 33***,
                "brokerNodeSubnetName": "sb2 | KR-2 | Private",
                "brokerNodeSubnetNo": 33***,
                "configGroupNo": 3**,
                "configGroupName": "cg1"
            }
        ],
        "disallowedClusters": [
            {
                "clusterName": "cluster01",
                "serviceGroupInstanceNo": "1009*****"
            }
        ]
    },
    "requestId": "f6713e31-****-****-****-665ad3ebda9c"
}