Check cluster status
- Print
- PDF
Check cluster status
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a VPC environment.
Description
Check a Cloud Data Streaming Service Cluster's status.
Request
Request URL
GET https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterStatus/{service-group-instance-no} [KR]
GET https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getClusterStatus/{service-group-instance-no} [SGN]
GET https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getClusterStatus/{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/jsonContent-Type: application/json |
Request parameters
| Parameter | Type | Required status | Description |
|---|---|---|---|
| serviceGroupInstanceNo | String | Y | This is the cluster number to check the status. |
Request example
GET https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getClusterStatus/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/getClusterStatus/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 clusterName;
Integer brokerNodeTotalNumber;
Integer brokerNumber;
String brokerStatus;
List<ProcessStatusVo> brokerStatusPerNode;
Integer zookeeperTotalNumber;
Integer zookeeperNumber;
String zookeeperStatus;
List<ProcessStatusVo> zookeeperStatusPerNode;
String cmakStatus;
}
public class ProcessStatusVo {
String hostname;
String status;
}
Field
| Parameter name | Type | Description |
|---|---|---|
| clusterName | String | Cluster name |
| brokerNodeTotalNumber | Integer | Total number of broker nodes |
| brokerNumber | Integer | Number of broker nodes currently operating |
| brokerStatus | String | Broker status (green: operating normally, red: operating abnormally) |
| brokerStatusPerNode | List | Broker status by node |
| zookeeperTotalNumber | Integer | Total number of ZooKeeper nodes |
| zookeeperNumber | Integer | Number of ZooKeeper nodes currently operating |
| zookeeperStatus | String | ZooKeeper status (green: operating normally, red: operating abnormally) |
| zookeeperStatusPerNode | List | Zookeeper status by node |
| cmakStatus | String | CMAK status (green: operating normally, red: operating abnormally) |
| hostname | String | Server instance name |
| status | String | Process status(green: operating normally, red: operating abnormally, gray: unknown status) |
Response example
{
"code": 0,
"message": "SUCCESS",
"result": {
"clusterName": "test",
"brokerNodeTotalNumber": 3,
"brokerNumber": 3,
"brokerStatus": "green",
"brokerStatusPerNode": [
{
"hostname": "test-b-95q",
"status": "green"
},
{
"hostname": "test-b-95r",
"status": "green"
},
{
"hostname": "test-b-95s",
"status": "green"
}
],
"zookeeperTotalNumber": 3,
"zookeeperNumber": 3,
"zookeeperStatus": "green",
"zookeeperStatusPerNode": [
{
"hostname": "test-b-95q",
"status": "green"
},
{
"hostname": "test-b-95r",
"status": "green"
},
{
"hostname": "test-b-95s",
"status": "green"
}
],
"cmakStatus": "green"
},
"requestId": "c2ce20ec-d296-43dd-872b-3a1d5e860a8b"
}
Was this article helpful?