Cloud Data Streaming Service Monitoring 데이터 조회
    • PDF

    Cloud Data Streaming Service Monitoring 데이터 조회

    • PDF

    기사 요약

    VPC 환경에서 이용 가능합니다.

    설명

    Cluster 또는 서버의 Cloud Data Streaming Service Monitoring 데이터를 조회합니다.

    요청

    요청 URL

    POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/monitoring/getCdssMonitoringData/{service-group-instance-no} [수도권]
    POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/krs-v1/monitoring/getCdssMonitoringData/{service-group-instance-no} [남부권]
    

    요청 헤더

    헤더명설명
    x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
    API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
    x-ncp-iam-access-key:{Account Access Key}
    x-ncp-apigw-signature-v2Access Key ID 값과 Secret Key로 암호화한 서명
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeRequest body content type을 application/json으로 지정
    Content-Type: application/json

    요청 파라미터

    파라미터타입필수 여부설명
    serviceGroupInstanceNoStringY조회할 Cluster의 번호
    timeStartLongY조회 시작 시간(Millisecond)
    timeEndLongY조회 종료 시간(Millisecond)
    metricStringY조회하려는 metric 명
    computeInstanceNoStringY조회할 서버의 Compute Instance No(Cluster Metric 조회 시, 매니저 서버의 Compute Instance No)
    intervalStringN집계 주기(default: Min1)
    • Cloud Data Streaming Service Metric(Cluster)
      호출 시 반드시, computeInstanceNo는 매니저 서버의 computeInstanceNo를 입력해야 합니다.
    MetricDescription
    CLUSTER_ALL_METRICS클러스터의 모든 Metric(Cloud Data Streaming Serivce의 모니터링 페이지에 있는 항목들)
    • Cloud Data Streaming Service Metric(서버)
    MetricDescription
    BROKER_ALL_METRICSBroker의 모든 Metric(Cloud Data Streaming Serivce의 모니터링 페이지에 있는 항목들)
    • Interval
    MetricDescription
    Min11분 간격으로 조회(최대 1일)
    Min55분 간격으로 조회(최대 1주일)
    Min3030분 간격으로 조회(최대 1개월)
    Hour22시간 간격으로 조회(최대 3개월)
    Day11일 간격으로 조회(최대 1년)

    요청 예시

    POST https://clouddatastreamingservice.apigw.gov-ntruss.com/api/v1/monitoring/getCdssMonitoringData/1773271
    HOST: clouddatastreamingservice.apigw.gov-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.gov-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"
     }'
    

    응답 파라미터

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

    필드

    파라미터명타입설명
    dataListMonitoring 데이터 정보
    dpsList<ArrayList>모니터링 정보(timestamp, data 형태)
    aggregationString조회하는 데이터의 집계함수
    dimensionsDimensionsVo조회하는 데이터의 구분자
    intervalString조회하는 데이터의 집계주기
    metricString조회하는 Metric 명
    graphNameString그래프 이름
    productNameString상품 이름
    instanceNoString조회하는 서버의 Compute Instance No

    응답 예시

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

    이 문서가 도움이 되었습니까?

    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.