MENU
      GetProductSchema

        GetProductSchema


        Article summary

        Available in Classic and VPC

        Get user-defined schema.

        Request

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

        MethodURI
        GET/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 query parameters

        You can use the following query parameters with your request:

        FieldTypeRequiredDescription
        prodNameStrngRequiredProduct name
        cw_keyStringOptionalProduct key (cw_key)

        Request example

        The request example is as follows:

        curl --location --request GET 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/schema?prodName=Custom/MyProduct&cw_key=***************' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        cw_keyString-Product key (cw_key)
        fieldsArray-User-defined schema
        prodNameString-Product name
        useCustomResourceBooleanOptionalWhether to use user-defined resources
        • true | false (default)
          • true: use
          • false: not use
        Note

        secret, which is not described in the response body, is a field that is scheduled to be deleted.

        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:

        {
            "cw_key": "**********",
            "fields": [
                {
                    "counter": false,
                    "dataType": "STRING",
                    "desc": "Dimension test 1 description",
                    "dimension": true,
                    "idDimension": true,
                    "metric": false,
                    "name": "Dimension_test_1"
                },
                {
                    "aggregations": {
                        "Min5": [
                            "SUM",
                            "MIN",
                            "AVG",
                            "COUNT",
                            "MAX"
                        ],
                        "Min1": [
                            "SUM",
                            "MIN",
                            "AVG",
                            "COUNT",
                            "MAX"
                        ],
                        "Hour2": [
                            "SUM",
                            "MIN",
                            "AVG",
                            "COUNT",
                            "MAX"
                        ],
                        "Day1": [
                            "SUM",
                            "MIN",
                            "AVG",
                            "COUNT",
                            "MAX"
                        ],
                        "Min30": [
                            "SUM",
                            "MIN",
                            "AVG",
                            "COUNT",
                            "MAX"
                        ]
                    },
                    "counter": false,
                    "dataType": "FLOAT",
                    "desc": "Metric Test 1 description",
                    "dimension": false,
                    "metric": true,
                    "metricType": "BASIC",
                    "name": "Metric_Test_1"
                }
            ],
            "prodName": "******",
            "useCustomResource": true
        }
        JSON

        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.