QueryDataMultiple

Prev Next

Classic/VPC環境で利用できます。

Cloud Insightで収集した複数の time-seriesデータを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /cw_fea/real/cw/api/data/query/multiple

リクエストヘッダ

Cloud Insight APIで共通して使用されるヘッダの詳細は、Cloud Insightのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
timeStart Integer Required 照会開始日時(ミリ秒)
  • Unix Timestamp形式
timeEnd Integer Required 照会終了日時(ミリ秒)
  • Unix Timestamp形式
metricInfoList Array Required 照会条件
  • 1回の呼び出しに最大20個の条件を照会可能
参考

リクエストボディの入力時、下記の内容をご確認ください。

  • スキーマ登録時に構成した集計関数(aggregation)とデータのクエリリクエストの集計が一致しない場合、データは取得できません。
  • データの集計周期(interval)によって推奨照会期間(timeEnd~timeStart)が異なります。詳細は、データ集計周期による推奨照会期間をご参照ください。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/data/query/multiple' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "metricInfoList": [
    {
      "aggregation": "AVG",
      "dimensions": {
        "instanceNo": "**********"
      },
      "interval": "Min1",
      "metric": "avg_cpu_used_rto",
      "prodKey": "**********"
    },
    {
      "aggregation": "AVG",
      "dimensions": {
        "instanceNo": "**********"
      },
      "interval": "Min1",
      "metric": "avg_read_byt_cnt",
      "prodKey": "**********"
    }
  ],
  "timeEnd": **********,
  "timeStart": **********
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
aggregation String - 集計関数
  • COUNT | SUM | MAX | MIN | AVG
dimensions Object - Dimension情報
dimensions.instanceNo String - インスタンス番号
dps Array - 照会結果
  • データポイント(Unix Timestamp形式)、データの値の形式で表示
interval String - 集計周期
  • Min1 | Min5 | Min30 | Hour2 | Day1
metric String - Metricの名前
productName String - 商品名

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Cloud Insight APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

[
    {
        "aggregation": "AVG",
        "dimensions": {
            "instanceNo": "**********"
        },
        "dps": [
            [
                1733184480000,
                0.3678916
            ],
            [
                1733184540000,
                0.33438668
            ],
            [
                1733184600000,
                0.32612613
            ],
            [
                1733184660000,
                0.32586497
            ],
            [
                1733184720000,
                0.30105397
            ]
        ],
        "interval": "Min1",
        "metric": "avg_cpu_used_rto",
        "productName": "Server(VPC)"
    },
    {
        "aggregation": "AVG",
        "dimensions": {
            "instanceNo": "**********"
        },
        "dps": [
            [
                1733184480000,
                24029.867
            ],
            [
                1733184540000,
                13107.2
            ],
            [
                1733184600000,
                13721.6
            ],
            [
                1733184660000,
                13107.2
            ],
            [
                1733184720000,
                13107.2
            ]
        ],
        "interval": "Min1",
        "metric": "avg_read_byt_cnt",
        "productName": "Server(VPC)"
    }
]