UpdateProductSchema
    • PDF

    UpdateProductSchema

    • PDF

    Article summary

    The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

    Available in Classic and VPC

    Update a user-defined schema.

    Note

    Since this is an API that edits the existing user-defined schema that has been registered, product information (product name, product key) about the schema to be updated is required when calling.
    See RegisterProductSchema to register a new user-defined schema.

    Request

    This section describes the request format. The method and URI are as follows:

    MethodURI
    PUT/cw_fea/real/cw/api/schema

    Request headers

    For information about the headers common to all Cloud Insight APIs, see Cloud Insight request headers.

    Request body

    You can include the following data in the body of your request:

    FieldTypeRequiredDescription
    prodNameStringRequiredProduct name
    cw_keyStringRequiredProduct key (cw_key)
    fieldsArrayRequiredUser-defined schema

    Request example

    The request example is as follows:

    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
    }'
    

    Response

    This section describes the response format.

    Response body

    The response body includes the following data:

    FieldTypeRequiredDescription
    msgString-Response result message

    Response status codes

    For response status codes common to NAVER Cloud Platform, see Cloud Insight API response status codes.

    Response example

    The response example is as follows:

    {
        "msg": "ok"
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.