UpdateProductSchema

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

ユーザー定義スキーマを更新します。

参考

登録されていた既存のユーザー定義スキーマを変更する APIなので、呼び出し時に更新するスキーマの商品情報(商品名、商品キー)が必要です。
新しいユーザー定義スキーマを登録するには、RegisterProductSchemaをご参照ください。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`prodName`	String	Required	商品名 Cloud Insight指標を参照
`cw_key`	String	Required	商品キー(cw_key) Cloud Insight指標を参照
`fields`	Array	Required	ユーザー定義スキーマ

リクエスト例

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

curl --location --request PUT '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 '{
    "cw_key": "**********",
    "fields": [
        {
            "counter": false,
            "dataType": "STRING",
            "desc": "Dimension test 1 description",
            "dimension": true,
            "idDimension": true,
            "metric": false,
            "name": "Dimension_test_1"
        },
        {
            "aggregations": {
                "Day1": [
                    "COUNT",
                    "MIN",
                    "AVG",
                    "MAX",
                    "SUM"
                ],
                "Min30": [
                    "COUNT",
                    "MIN",
                    "AVG",
                    "MAX",
                    "SUM"
                ],
                "Hour2": [
                    "COUNT",
                    "MIN",
                    "AVG",
                    "MAX",
                    "SUM"
                ],
                "Min5": [
                    "COUNT",
                    "MIN",
                    "AVG",
                    "MAX",
                    "SUM"
                ],
                "Min1": [
                    "COUNT",
                    "MIN",
                    "AVG",
                    "MAX",
                    "SUM"
                ]
            },
            "counter": false,
            "dataType": "FLOAT",
            "desc": "Metric Test 1 description",
            "dimension": false,
            "metric": true,
            "metricType": "BASIC",
            "name": "Metric_Test_1"
        }
    ],
    "prodName": "MyProduct_edited",
    "secret": "***********",
    "useCustomResource": true
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`msg`	String	-	レスポンス結果メッセージ

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

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

レスポンス例

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

{
    "msg": "ok"
}