Search single Cloud Data Streaming Service cluster
- Print
- PDF
Search single Cloud Data Streaming Service cluster
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It is available in a VPC environment.
Description
Searches the cluster that exists in Cloud Data Streaming Service.
Request
Request URL
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList/{service-group-instance-no} [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getClusterInfoList/{service-group-instance-no} [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getClusterInfoList/{service-group-instance-no} [JPN]
Request header
| Header name | 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 | Value of access key ID issued in the NAVER Cloud Platform portalx-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specifies the request body content type as application/jsonContent-Type: application/json |
Request parameter
| Parameter | Type | Requirement status | Description |
|---|---|---|---|
| serviceGroupInstanceNo | String | Y | Number of cluster whose list of broker nodes is searched |
Request examples
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList/2434156
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 POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterInfoList/2434156 \
-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 parameter
public class GetClusterInfoResponseVo {
String clusterName;
String kafkaVersionCode;
String kafkaManagerUserName;
String softwareProductCode;
Integer vpcNo;
String managerNodeProductCode;
Integer managerNodeSubnetNo;
String brokerNodeProductCode;
Integer brokerNodeSubnetNo;
Integer brokerNodeCount;
Long brokerNodeStorageSize;
Integer configGroupNo;
String status;
}
Field
| Parameter name | Type | Description |
|---|---|---|
| clusterName | String | Cluster name |
| kafkaVersionCode | String | Kafka version code |
| kafkaManagerUserName | String | CMAK access ID |
| softwareProductCode | String | OS type being used |
| vpcNo | Integer | Number of the VPC where the server is located |
| managerNodeProductCode | String | HW specifications of the manager node |
| managerNodeSubnetNo | Integer | Number of the subnet where the manager node is located |
| brokerNodeProductCode | String | HW specifications of the broker node |
| brokerNodeSubnetNo | Integer | Name of the subnet where the broker node is located |
| brokerNodeCount | Integer | Number of broker nodes |
| brokerNodeStorageSize | Integer | Broker node storage capacity |
| conifgGroupNo | Integer | Number of ConfigGroup |
| status | String | Current cluster status |
Response examples
{
"code": 0,
"message": "SUCCESS",
"result": {
"clusterName": "for-swagger",
"kafkaVersionCode": "2403005",
"kafkaManagerUserName": "string",
"kafkaManagerUserPassword": "jeuJTgm5c6sYDlAcRrMf1A==",
"softwareProductCode": "SW.VCDSS.OS.LNX64.CNTOS.0708.B050",
"vpcNo": 3438,
"managerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
"managerNodeSubnetNo": 5573,
"brokerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
"brokerNodeSubnetNo": 4853,
"brokerNodeCount": 3,
"brokerNodeStorageSize": 100,
"configGroupNo": 127,
"status": "running"
},
"requestId": "6ab5082c-b672-411f-9174-877a658d0148"
}
Was this article helpful?