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.gov-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은 삭제 예정 필드입니다.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 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
}