Get cluster

Available in VPC

Get Cloud Data Streaming Service cluster details.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
POST	/api/v1/cluster/getClusterInfoList/{serviceGroupInstanceNo} (Korea Region)
POST	/api/sgn-v1/cluster/getClusterInfoList/{serviceGroupInstanceNo} (Singapore Region)
POST	/api/jpn-v1/cluster/getClusterInfoList/{serviceGroupInstanceNo} (Japan Region)

Request headers

For information about the headers common to all Cloud Data Streaming Service APIs, see Cloud Data Streaming Service request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`serviceGroupInstanceNo`	Integer	Required	Cluster instance number See Get cluster list.

Request example

The request example is as follows:

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'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`code`	Integer	-	Response code
`message`	String	-	Response message
`result`	Object	-	Response result
`result.clusterName`	String	-	Cluster name
`result.kafkaVersionCode`	String	-	Kafka version code
`result.kafkaManagerUserName`	String	-	CMAK access account ID
`result.softwareProductCode`	String	-	Operating system type code
`result.vpcNo`	Integer	-	VPC number
`result.managerNodeProductCode`	String	-	Manager node server type code
`result.managerNodeSubnetNo`	Integer	-	Manager node subnet number
`result.brokerNodeProductCode`	String	-	Broker node server type code
`result.brokerNodeSubnetNo`	Integer	-	Broker node subnet number
`result.brokerNodeCount`	Integer	-	Number of broker nodes
`result.brokerNodeStorageSize`	Integer	-	Storage capacity by broker node (GB)
`result.configGroupNo`	Integer	-	Config group number
`result.status`	String	-	Cluster status
`requestId`	String	-	ID for the request UUID format

Response status codes

For information about the HTTP status codes common to all Cloud Data Streaming Service APIs, see Cloud Data Streaming Service response status codes.

Response example

The response example is as follows:

{
    "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"
}