QueryData

Prev Next

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

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

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

データ照会リクエスト情報関連フィールドの詳細は、DataQueryRequestをご参照ください。

参考

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

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

リクエスト例

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

curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/data/query' \
--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 '{
    "timeEnd": **********,
    "timeStart": **********,
    "cw_key": "**********",
    "productName":"System/Server(VPC)",
    "metric": "avg_cpu_used_rto",
    "interval": "Min1",
    "aggregation": "AVG",
    "dimensions": {
        "instanceNo": "**********"
    }
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
data Array - 照会結果
  • データポイント(Unix Timestamp形式)、データの値の形式で表示

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

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

レスポンス例

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

[
    [
        1733184480000,
        0.3678916
    ],
    [
        1733184540000,
        0.33438668
    ],
    [
        1733184600000,
        0.32612613
    ],
    [
        1733184660000,
        0.32586497
    ],
    [
        1733184720000,
        0.30105397
    ],
    [
        1733184780000,
        0.35094023
    ]
]