MENU
      Cloud Data Streaming Service Monitoring data inquiry

        Cloud Data Streaming Service Monitoring data inquiry


        Article summary

        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]
        HTTP

        Request header

        Header nameDescription
        x-ncp-apigw-timestampThis 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-keyAccess key ID value issued on the NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeSpecifies the request body content type as application/json
        Content-Type: application/json

        Request parameters

        ParameterTypeRequirement statusDescription
        serviceGroupInstanceNoStringYCluster number to be searched
        timeStartLongYSearch start time (milliseconds)
        timeEndLongYSearch end time (milliseconds)
        metricStringYMetric name to be searched
        computeInstanceNoStringYCompute instance number of the server to be searched (compute instance number of the manager server if searching cluster metric)
        intervalStringNAggregation interval (default: Min1)
        • Cloud Data Streaming Service Metric(Cluster)
          When calling, the computeInstanceNo of the manager server must be entered for the computeInstanceNo.
        MetricDescription
        CLUSTER_ALL_METRICSAll metrics in the cluster
        • Cloud Data Streaming Service Metric (server)
        MetricDescription
        BROKER_ALL_METRICSALL Metrics in the broker
        • Interval
        MetricDescription
        Min1Search every minute (up to one day)
        Min5Search every 5 minutes (up to one week)
        Min30Search every 30 minutes (up to one month)
        Hour2Search every 2 hours (up to 3 months)
        Day1Search 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"
        }
        HTTP
        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"
         }'
        Bash

        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;
        }
        Java

        Field

        Parameter nameTypeDescription
        dataListMonitoring data information
        dpsList<ArrayList>Monitoring information (timestamp, data format)
        aggregationStringAggregation functions of the searched data
        dimensionsDimensionsVoSeparators of the searched data
        intervalStringAggregation interval of the searched data
        metricStringName of the searched metric
        graphNameStringGraph name
        productNameStringProduct name
        instanceNoStringCompute 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"
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.