Cloud Data Streaming Service Monitoring data inquiry
- Print
- PDF
Cloud Data Streaming Service Monitoring data inquiry
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a VPC environment.
Description
View the Cloud Data Streaming Service monitoring data of clusters or servers.
Requests
Request URL
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/monitoring/getCdssMonitoringData/{service-group-instance-no} [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/monitoring/getCdssMonitoringData/{service-group-instance-no} [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/monitoring/getCdssMonitoringData/{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 | Access key ID value issued on 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 parameters
| Parameter | Type | Requirement status | Description |
|---|---|---|---|
| serviceGroupInstanceNo | String | Y | Cluster number to be searched |
| timeStart | Long | Y | Search start time (milliseconds) |
| timeEnd | Long | Y | Search end time (milliseconds) |
| metric | String | Y | Metric name to be searched |
| computeInstanceNo | String | Y | Compute instance number of the server to be searched (compute instance number of the manager server if searching cluster metric) |
| interval | String | N | Aggregation interval (default: Min1) |
- Cloud Data Streaming Service Metric(Cluster)
When calling, the computeInstanceNo of the manager server must be entered for the computeInstanceNo.
| Metric | Description |
|---|---|
| CLUSTER_ALL_METRICS | All metrics in the cluster |
- Cloud Data Streaming Service Metric (server)
| Metric | Description |
|---|---|
| BROKER_ALL_METRICS | ALL Metrics in the broker |
- Interval
| Metric | Description |
|---|---|
| Min1 | Search every minute (up to one day) |
| Min5 | Search every 5 minutes (up to one week) |
| Min30 | Search every 30 minutes (up to one month) |
| Hour2 | Search every 2 hours (up to 3 months) |
| Day1 | Search every day (up to one year) |
Request example
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/monitoring/getCdssMonitoringData/1773271
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
{
"timeEnd": "1626240000000",
"timeStart": "1626239850000",
"metric": "CLUSTER_ALL_METRICS",
"computeInstanceNo": "1773272",
"interval" : "Min1"
}
curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/monitoring/getCdssMonitoringData/1773271 \
-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 \
'{
"timeEnd": "1626240000000",
"timeStart": "1626239850000",
"metric": "CLUSTER_ALL_METRICS",
"computeInstanceNo": "1773272",
"interval" : "Min1"
}'
Response parameters
public class QueryDataResponseVo {
List<MetricInfoResponseVo> data;
}
public class MetricInfoResponseVo{
List<ArrayList<Object>> dps;
String aggregation;
DimensionsVo dimensions;
String interval;
String metric;
String graphName;
String productName;
}
public class DimensionsVo {
String instanceNo;
}
Field
| Parameter name | Type | Description |
|---|---|---|
| data | List | Monitoring data information |
| dps | List<ArrayList | Monitoring information (timestamp, data format) |
| aggregation | String | Aggregation functions of the searched data |
| dimensions | DimensionsVo | Separators of the searched data |
| interval | String | Aggregation interval of the searched data |
| metric | String | Name of the searched metric |
| graphName | String | Graph name |
| productName | String | Product name |
| instanceNo | String | Compute instance number of the searched server |
Response example
{
"code": 0,
"message": "SUCCESS",
"result": {
"data": [
{
"dps": [
[
1626239880000,
1
],
[
1626239940000,
1
],
[
1626240000000,
1
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "Topics Total",
"graphName": "Topics Total",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
1
],
[
1626239940000,
1
],
[
1626240000000,
1
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "Partitions Total",
"graphName": "Partitions Total",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "Messages Total",
"graphName": "Messages Total",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "messagesInSecMean",
"graphName": "Messages In(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "messagesInSecOneMin",
"graphName": "Messages In(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "messagesInSecFiveMin",
"graphName": "Messages In(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "messagesInSecFifteenMin",
"graphName": "Messages In(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "bytesInSec",
"graphName": "Bytes In(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "bytesInSecOneMin",
"graphName": "Bytes In(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "bytesInSecFiveMin",
"graphName": "Bytes In(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "bytesInSecFifteenMin",
"graphName": "Bytes In(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "bytesOutSec",
"graphName": "Bytes Out(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "bytesOutSecOneMin",
"graphName": "Bytes Out(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "bytesOutSecFiveMin",
"graphName": "Bytes Out(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "bytesOutSecFifteenMin",
"graphName": "Bytes Out(/sec)",
"productName": "Cloud Data Streaming Service(VPC)"
}
]
},
"requestId": "1eac9895-ea20-4cc1-8a09-cf4d116ccd7e"
}
Was this article helpful?