Check broker node information
  • PDF

Check broker node information

  • PDF

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Can be used in a VPC environment.

Description

Check a Cloud Data Streaming Service Cluster's broker node information.

Request

Request URL

GET https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getBrokerInfo/{service-group-instance-no} [KR]
GET https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getBrokerInfo/{service-group-instance-no} [SGN]
GET https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getBrokerInfo/{service-group-instance-no} [JPN]

Request headers

Header Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key This is the Access Key ID value issued by the Naver Cloud Platform.
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 This is the signature encrypted Access Key ID value and Secret Key.
x-ncp-apigw-signature-v2:{API Gateway Signature}
Content-Type Specifies the request body content type as application/json
Content-Type: application/json

Request parameters

Parameter Type Required status Description
serviceGroupInstanceNo String Y This is the cluster number to check the broker node information.

Request example

GET https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getBrokerInfo/1484848
HOST: clouddatastreamingservice.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
x-ncp-apigw-timestamp: 1593848345548
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
curl -X GET "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getBrokerInfo/1484848" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
-H "x-ncp-apigw-timestamp: 1601971222179" \
-H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4=" 

Response parameters

public class GetBrokerNodeListsResponseVo {
    String brokerNodeList;
    String brokerTlsNodeList;
    String localDnsList;
    String zookeeperList;
}

Field

Parameter name Type Description
brokerNodeList String List of broker nodes (Port 9092)
brokerTlsNodeList String List of broker nodes (Port 9093)
localDnsList String Editing details of the hosts file (Private IP hostname format)
zookeeperList String List of ZooKeeper nodes (Port 2181)

Response example

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "brokerNodeList": "10.0.1.29:9092,10.0.1.30:9092,10.0.1.31:9092,10.0.1.32:9092",
    "brokerTlsNodeList": "tesss-b-4hq:9093,tesss-b-4hr:9093,tesss-b-4hs:9093,tesss-b-4ht:9093",
    "localDnsList": "10.0.1.29 tesss-b-4hq\n10.0.1.30 tesss-b-4hr\n10.0.1.31 tesss-b-4hs\n10.0.1.32 tesss-b-4ht\n",
    "zookeeperList": "10.0.1.29:2181,10.0.1.30:2181,10.0.1.31:2181"
  },
  "requestId": "d9659ae8-952a-4d69-a166-ab22b49b6a44"
}

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.