CreateCustomSchema

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

ユーザー定義スキーマを作成します。

リクエスト

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

メソッド	URI
POST	/cw_fea/real/cw/api/schema

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`prodName`	Array	Required	スキーマ名
`fields`	Array	Required	ユーザー定義スキーマ
`useCustomResource`	Boolean	Optional	ユーザー定義リソースの使用有無 `true` \| `false` (デフォルト) `true`: 使用 `false`: 使用しない

リクエスト例

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

curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/schema' \
--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 '{
  "prodName": "Custom/MyProduct",
  "fields": [
    {
      "dataType": "STRING",
      "name": "Dimension_test",
      "dimension": true,
      "metric": false,
      "counter": false,
      "idDimension": true,
      "desc": "Dimension test description"
    },
    {
      "dataType": "FLOAT",
      "name": "Metric_Test",
      "dimension": false,
      "metric": true,
      "counter": false,
      "desc": "Metric Test 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"
          ]
      }
    }
  ],
  "useCustomResource": true
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`cw_key`	String	-	商品キー(cw_key) Cloud Insight指標を参照

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

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

レスポンス例

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

{
    "cw_key": "**********"
}

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

What's Next

DeleteProductSchema

リクエスト
レスポンス

タグ

Cloud Insight