Cloud Data Streaming Service Monitoringデータ照会

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VPC環境で利用できます。

説明

クラスタまたはサーバのCloud Data Streaming Service Monitoringデータを照会します。

リクエスト

リクエスト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]

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームのポータルから発行されたAccess Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値とSecret Keyで暗号化された署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Request body content typeをapplication/jsonに指定 `Content-Type: application/json`

リクエストパラメータ

パラメータ	タイプ	必須有無	説明
serviceGroupInstanceNo	String	Y	照会するクラスタの番号です。
timeStart	Long	Y	照会開始時間(Millisecond)
timeEnd	Long	Y	照会終了時間(Millisecond)
metric	String	Y	照会するMetric名
computeInstanceNo	String	Y	照会するサーバのCompute Instance No(Cluster Metricを照会する場合はマネージャーサーバのCompute Instance No)
interval	String	N	集計サイクル(default: Min1)

Cloud Data Streaming Service Metric(Cluster)
呼び出し時には必ず、マネージャーサーバのcomputeInstanceNoをcomputeInstanceNoに入力しなければなりません。

Metric	Description
CLUSTER_ALL_METRICS	クラスタ内のすべてMetric

Cloud Data Streaming Service Metric(サーバ)

Metric	Description
BROKER_ALL_METRICS	BrokerのすべてのMetric

Interval

Metric	Description
Min1	1分おきに照会(最大1日)
Min5	5分おきに照会(最大1週間)
Min30	30分おきに照会(最大1ヶ月)
Hour2	2時間おきに照会(最大3ヶ月)
Day1	1日おきに照会(最大1年)

リクエスト例

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

レスポンスパラメータ

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

フィールド

パラメータ名	タイプ	説明
data	List	Monitoringデータの情報
dps	List<ArrayList	モニタリング情報(timestamp、データ形式)
aggregation	String	照会するデータの集計関数
dimensions	DimensionsVo	照会するデータの区切り文字
interval	String	照会するデータの集計サイクル
metric	String	照会するMetric名
graphName	String	グラフ名
productName	String	商品名
instanceNo	String	照会するサーバの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"
}

この記事は役に立ちましたか?

What's Next

OS Monitoringデータ照会

説明
リクエスト
レスポンスパラメータ
フィールド

タグ

Cloud Data Streaming Service