GetProductSchema

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

Get user-defined schema.

Request

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

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:

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

Response

This section describes the response format.

Response body

The response body includes the following data:

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
}