ノード通信情報の照会

Prev Next

VPC環境で利用できます。

Cloud Data Streaming Serviceクラスタブローカーノードの通信情報を照会します。

リクエスト

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

メソッド URI
GET /api/v1/cluster/getBrokerInfo/{serviceGroupInstanceNo} (韓国リージョン)
GET /api/sgn-v1/cluster/getBrokerInfo/{serviceGroupInstanceNo} (シンガポールリージョン)
GET /api/jpn-v1/cluster/getBrokerInfo/{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/getBrokerInfo/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.brokerNodeDnsInfoList Array - ブローカーノードの DNS情報
result.brokerNodeList String - ブローカーノードリスト (PlainText接続)
  • 9092ポート使用
result.brokerTlsNodeList String - ブローカーノードリスト(TLS接続)
  • 9093ポート使用
result.publicEndpointBrokerNodeList String - ブローカーノード Public Endpointリスト(PlainText接続)
result.publicEndpointBrokerNodeListenerPortList String - ブローカーノードリスナーポートリスト(PlainText接続)
result.publicEndpointBrokerTlsNodeList String - ブローカーノード Public Endpointリスト(TLS接続)
result.publicEndpointBrokerTlsNodeListenerPortList String - ブローカーノードリスナーポートリスト(TLS接続)
result.localDnsList String - hostsファイルの変更情報(PlainText接続)
  • プライベート IPアドレスとホスト名形式
result.localDnsTlsList String - hostsファイルの変更情報(TLS接続)
  • グローバル IPアドレスとホスト名形式
result.zookeeperList String - ZooKeeperノードリスト
  • 2181ポート使用
result.publicEndpointBrokerNodeDnsList String - ブローカーノード DNSリスト(PlainText接続)
result.publicEndpointBrokerTlsNodeDnsList String - ブローカーノード DNSリスト(TLS接続)
requestId String - リクエスト ID
  • UUID形式

brokerNodeDnsInfoList

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

フィールド タイプ 必須の有無 説明
hostName String - ホスト名
dns String - DNS
ip String - IPアドレス
plainTextPort Integer - PlainText接続ポート番号
tlsPort Integer - TLS接続ポート番号

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "brokerNodeDnsInfoList": [
            {
                "hostName": "cluster02-b-264s",
                "dns": "*********************************************",
                "ip": "10.0.20.14",
                "plainTextPort": 9094,
                "tlsPort": 9095
            },
            {
                "hostName": "cluster02-b-264t",
                "dns": "*********************************************",
                "ip": "10.0.20.15",
                "plainTextPort": 9094,
                "tlsPort": 9095
            },
            {
                "hostName": "cluster02-b-264u",
                "dns": "*********************************************",
                "ip": "10.0.20.16",
                "plainTextPort": 9094,
                "tlsPort": 9095
            },
            {
                "hostName": "cluster02-b-266j",
                "dns": "*********************************************",
                "ip": "10.0.20.10",
                "plainTextPort": 9094,
                "tlsPort": 9095
            },
            {
                "hostName": "cluster02-b-266k",
                "dns": "*********************************************",
                "ip": "10.0.20.11",
                "plainTextPort": 9094,
                "tlsPort": 9095
            }
        ],
        "brokerNodeList": "10.0.20.14:9092,10.0.20.15:9092,10.0.20.16:9092,10.0.20.10:9092,10.0.20.11:9092",
        "brokerTlsNodeList": "cluster02-b-264s:9093,cluster02-b-264t:9093,cluster02-b-264u:9093,cluster02-b-266j:9093,cluster02-b-266k:9093",
        "publicEndpointBrokerNodeList": "lblblb-1009*****-***********.kr.lb.naverncp.com:9100,lblblb-1009*****-***********.kr.lb.naverncp.com:9101,lblblb-1009*****-***********.kr.lb.naverncp.com:9102,lblblb-1009*****-***********.kr.lb.naverncp.com:9103,lblblb-1009*****-***********.kr.lb.naverncp.com:9104",
        "publicEndpointBrokerNodeListenerPortList": "cluster02-b-264s 9100\ncluster02-b-264t 9101\ncluster02-b-264u 9102\ncluster02-b-266j 9103\ncluster02-b-266k 9104\n",
        "publicEndpointBrokerTlsNodeList": "cluster02-b-264s:9300,cluster02-b-264t:9301,cluster02-b-264u:9302,cluster02-b-266j:9303,cluster02-b-266k:9304",
        "publicEndpointBrokerTlsNodeListenerPortList": "cluster02-b-264s 9300\ncluster02-b-264t 9301\ncluster02-b-264u 9302\ncluster02-b-266j 9303\ncluster02-b-266k 9304\n",
        "localDnsList": "10.0.20.14 cluster02-b-264s\n10.0.20.15 cluster02-b-264t\n10.0.20.16 cluster02-b-264u\n10.0.20.10 cluster02-b-266j\n10.0.20.11 cluster02-b-266k\n",
        "localDnsTlsList": "***.***.***.*** cluster02-b-264s\n***.***.***.*** cluster02-b-264t\n***.***.***.*** cluster02-b-264u\n***.***.***.*** cluster02-b-266j\n***.***.***.*** cluster02-b-266k\n",
        "zookeeperList": "10.0.20.14:2181,10.0.20.15:2181,10.0.20.16:2181",
        "publicEndpointBrokerNodeDnsList": "cluster02-b-264s-***********.kr.cdss.naverncp.com:9094,cluster02-b-264t-***********.kr.cdss.naverncp.com:9094,cluster02-b-264u-***********.kr.cdss.naverncp.com:9094,cluster02-b-266j-***********.kr.cdss.naverncp.com:9094,cluster02-b-266k-***********.kr.cdss.naverncp.com:9094",
        "publicEndpointBrokerTlsNodeDnsList": "cluster02-b-264s-***********.kr.cdss.naverncp.com:9095,cluster02-b-264t-***********.kr.cdss.naverncp.com:9095,cluster02-b-264u-***********.kr.cdss.naverncp.com:9095,cluster02-b-266j-***********.kr.cdss.naverncp.com:9095,cluster02-b-266k-***********.kr.cdss.naverncp.com:9095"
    },
    "requestId": "f43ae695-****-****-****-04bb8085ed35"
}