RegisterProductSchema

概要

Cloud Insightでユーザー定義スキーマを登録します。

リクエスト

API URL

URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/schema
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}

リクエストボディ

例

リクエスト例

POST /cw_fea/real/cw/api/schema
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:

{
  "prodName": "Custom/MyProduct",
  "fields": [
    {
      "dataType": "STRING",
      "name": "dimensionName",
      "dimension": true,
      "metric": false,
      "counter": false,
      "idDimension": true|false,
      "desc": "description"
    },
    {
      "dataType": "STRING|INTEGER|FLOAT|LONG",
      "name": "metricName",
      "dimension": false,
      "metric": true,
      "counter": false,
      "desc": "description",
          "aggregations": {
          "Min1": [
            "AVG",
            "SUM",
            "MIN",
            "MAX",
            "COUNT"
          ],
          "Min5": [
            "AVG",
            "SUM",
            "MIN",
            "MAX",
            "COUNT"
          ],
          "Min30": [
            "AVG",
            "SUM",
            "MIN",
            "MAX",
            "COUNT"
          ],
          "Hour2": [
            "AVG",
            "SUM",
            "MIN",
            "MAX",
            "COUNT"
          ],
          "Day1": [
            "AVG",
            "SUM",
            "MIN",
            "MAX",
            "COUNT"
          ]
      }
    }
  ]
}

参照：

1. DimensionおよびMetricフィールドの場合デフォルト値はfalseで、falseの場合はリクエストで無視できます。

2. Metricフィールドの場合、各間隔に対して集計が指定されます。 フィールド要素にaggregationがない場合は、各間隔に対して集計方法が自動的に指定されます。

3. mbrNoは予約語で、Dimension名としては使用できません。

レスポンス例

エラーなしに登録が完了した場合、HTTP code 200と商品キー(cw_key)を含む簡単なJSON形式のレスポンスがリターンされます。 商品キーは、スキーマをアップデートあるいは削除する場合に必要であり、データを伝送して照会する際に使用されます。

{
  "cw_key": "xxxxxxxxxxxxxxxxxx"
}