QueryData

概要

Cloud Insightで収集したtime-seriesデータをクエリします。

リクエスト

API URL

URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/data/query
Method: POST

リクエストヘッダ

共通設定に明示されたリクエストヘッダが必要です。

Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

リクエストボディ

DataQueryRequest

{
  "timeStart": "long",
  "timeEnd": "long",
  "cw_key": "string",
  "productName": "string",
  "metric": "string",
  "interval": "string",
  "aggregation": "string",  
  "queryAggregation": "string",
  "dimensions": {
      "string": "string",
      "string": "string"
  }
}

参照：

• aggregationの場合、Databaseに書き込む前、データストリームがシステムに取り込まれる際に実行される集計関数を意味します。

• 一致しないとユーザーはデータを取得できないため、スキーマ登録時に構成した集計関数(aggregation)とデータのクエリリクエストの集計を一致させてください。

• データ集計周期(interval)による推奨照会期間(timeEnd - timeStart)が異なります。 詳しい内容は、データ集計周期による推奨照会期間を参考にしてください。

例

リクエスト例

以下は、「System/Server」商品でinstanceNo(Dimension)が「123456」であるサーバのall_byt_cnt(Metric)値を照会する例です。

POST /cw_fea/real/cw/api/data/query
Host: cw.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

Payload:

{
  "timeEnd": 1565056980000, 
  "timeStart": 1565020800000,
  "cw_key": "xxxxxxxxxxxxxxxxxx",
  "productName":"System/Server",
  "metric": "all_byt_cnt",
  "interval": "Min1",
  "aggregation": "AVG",
  "dimensions": {
    "instanceNo": "123456"
  }
}

レスポンス例

レスポンスはJSON配列で、内部配列があり、内部配列の最初の値はデータポイントのtimestampであり、2番目のものは値です。

[
  [
    1553734800000,
    11.5
  ],
  [
    1553734860000,
    9.583333015441895
  ],
  [
    1553734920000,
    11.5
  ]
]