GetProductSchema

Prev Next

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

ユーザー定義スキーマを照会します。

リクエスト

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

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

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
prodName Strng Required 商品名
cw_key String Optional 商品キー(cw_key)

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

レスポンスボディで説明されていないsecretは削除予定のフィールドです。

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

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

レスポンス例

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

{
    "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
}