Search Cloud Data Streaming Service Cluster list

Article summary

Did you find this summary helpful?

Thank you for your feedback

Can be used in a VPC environment.

Description

Search a list of Cloud Data Streaming Service Clusters.

Request

Request URL

POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getClusterInfoList?pageNo={pageNo}&pageSize={pageSize} [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
inputText	String	N	This is the cluster name to search.
vpcName	String	N	Search the cluster using the VPC.
pageNo	Integer	N	This is the page number. `Default : 1` ex) 1, 2
pageSize	Integer	N	This is the page size. `Defatlt : 10` ex) 10, 20

Request example

POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList
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

{
  "inputText" : "open",
  "vpcName": "test",
  "pageNo" : 1,
  "pageSize" : 10
}

curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList?pageNo=1&pageSize=10 \
-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=" \
-d \
'{
   "inputText" : "open",
   "vpcName": "test",
   "pageNo" : 1,
   "pageSize" : 10
 }'

Response parameters

public class GetClusterInfoListResponseVo {
    private List<AllowedClusterInfo> allowedClusters;
    private List<DisallowedClusterInfo> disallowedClusters;
    private Integer currentPage;
    private Boolean isFirst;
    private Boolean isLast;
    private Integer pageSize;
    private Long totalCount;
    private Integer totalPage;
}

public class AllowedClusterInfo {
    private String clusterName;
    private String brokerNodeType;
    private String brokerNodeProductName;
    private Integer brokerNodeCount;
    private String applicationVersion;
    private String kafkaVersion;
    private String cmakVersion;
    private String softwareProductName;
    private Date createDate;
    private String managerNodeType;
    private Integer managerNodeCount;
    private String clusterPublicDomain;
    private Boolean isUsePublicDomain;
    private Long dataStorageVolumeSize;
    private Integer managerNodeAccessControlGroupSequence;
    private String managerNodeAccessControlGroupName;
    private Integer brokerNodeAccessControlGroupSequence;
    private String brokerNodeAccessControlGroupName;
    private Integer kafkaBrokerPort;
    private Integer kafkaBrokerTlsPort;
    private Integer zookeeperPort;
    private Integer cmakPort;
    private String serviceGroupInstanceNo;
    private String kafkaManagerUserName;
    private String memberNo;
    private String vpcName;
    private Integer vpcNo;
    private String managerNodeSubnetName;
    private Integer managerNodeSubnetNo;
    private String brokerNodeSubnetNo;
    private Integer brokerNodeSubnetNo;
    private Integer configGroupNo;
    private String configGroupName;
}

public class DisallowedClusterInfo {
    private String clusterName;
    private String serviceGroupInstanceNo;
}

Field

Parameter name	Type	Description
serviceGroupInstanceNo	String	serviceGroupInstanceNo of the cluster created
allowedClusters	List	Cluster list
disallowedClusters	List	List of clusters without getClusterDetail permissions when calling with Subaccount
currentPage	Integer	Current page
isFirst	Boolean	First page status
isLast	Boolean	Last page status
pageSize	Integer	Page size
totalCount	Long	Total number of the cluster's lists
totalPage	Integer	Total page number
clusterName	String	Cluster name
brokerNodeType	String	Broker node type
brokerNodeProductName	String	Broker node type name
brokerNodeCount	Integer	Number of broker nodes
applicationVersion	String	Cloud Data Streaming Service version
cmakVersion	String	CMAK version
kafkaVersion	String	Kafka version
softwareProductName	String	OS product name
createDate	Date	Created date
managerNodeType	String	Manager node type
managerNodeCount	Integer	Number of manager nodes
clusterPublicDomain	String	Cluster access domain
isUsePublicDomain	Boolean	Whether to use Public Domain
brokerStorageVolumeSize	Long	Broker node storage size
managerNodeAccessControlGroupSequence	Integer	Number of the manager node ACG
managerNodeAccessControlGroupName	String	Manager node ACG name
brokerNodeAccessControlGroupSequence	Integer	Number of the broker node ACG
brokerNodeAccessControlGroupName	String	Name of the broker node ACG
kafkaBrokerPort	String	Broker node port
kafkaBrokerTlsPort	String	Broker node TLS port
zookeeperPort	String	ZooKeeper node port
cmakPort	String	CMAK connection port
serviceGroupInstanceNo	String	Cluster instance number
kafkaManagerUserName	String	CMAK connection ID
memberNo	String	Customer number
vpcName	String	Name of the VPC where the server is located
vpcNo	Integer	Number of the VPC where the server is located
managerNodeSubnetName	String	Name of the subnet where the manager node is located
managerNodeSubnetNo	Integer	Number of the subnet where the manager node is located
brokerNodeSubnetName	String	Name of the subnet where the broker node is located
brokerNodeSubnetNo	Integer	Number of the subnet where the broker node is located
conifgGroupNo	Integer	Number of the ConfigGroup
conifgGroupName	String	Name of the ConfigGroup

Response example

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "currentPage": 1,
    "isFirst": true,
    "isLast": true,
    "pageSize": 10,
    "totalCount": 1,
    "totalPage": 1,
    "allowedClusters": [
      {
        "clusterName": "tesss",
        "brokerNodeType": "2vCPU, 4GB Mem",
        "brokerNodeProductName": "2 vCPUs, 4 GB memory, 50 GB [SSD] disk",
        "brokerNodeCount": 4,
        "serverStatus": "running",
        "applicationVersion": "Kafka 2.4.0, CMAK 3.0.0.5",
        "kafkaVersion": "2.4.0",
        "cmakVersion": "3.0.0.5",
        "softwareProductName": "CentOS 7.3 (64-bit)",
        "createDate": "2020-10-26 11:54:35",
        "managerNodeType": "2vCPU, 4GB Mem",
        "managerNodeCount": 1,
        "clusterPublicDomain": "tesss-1524372151.kr.cdss.beta.naverncp.com",
        "isUsePublicDomain": true,
        "brokerStorageVolumeSize": 429496729600,
        "managerNodeAccessControlGroupSequence": 3751,
        "managerNodeAccessControlGroupName": "cdss-m-wd2v",
        "brokerNodeAccessControlGroupSequence": 3750,
        "brokerNodeAccessControlGroupName": "cdss-b-wd2v",
        "kafkaBrokerPort": 9092,
        "kafkaBrokerTlsPort": 9093,
        "zookeeperPort": 2181,
        "cmakPort": 9000,
        "serviceGroupInstanceNo": "1509943",
        "kafkaManagerUserName": "yea",
        "memberNo": "703",
        "vpcName": "clean",
        "vpcNo": 1236,
        "managerNodeSubnetName": "clean-pub | KR-1",
        "managerNodeSubnetNo": 1300,
        "brokerNodeSubnetName": "clean-private | KR-1",
        "brokerNodeSubnetNo": 1301,
        "configGroupNo": 127,
        "configGroupName": "test-config"
      }
    ],
    "disallowedClusters": []
  },
  "requestId": "e465729c-aff5-4aaf-8981-ed8c87dcd2ca"
}

Was this article helpful?

What's Next

Search single Cloud Data Streaming Service cluster

Table of contents

Description
Request
Response parameters
Field