UpdateProductSchema

Classic/VPC 환경에서 이용 가능합니다.

사용자 정의 스키마를 업데이트합니다.

참고

등록되어 있던 기존의 사용자 정의 스키마를 수정하는 API이기 때문에 호출 시 업데이트할 스키마에 대한 상품 정보(상품 이름, 상품 키)가 반드시 필요합니다.
새로운 사용자 정의 스키마를 등록하려면 RegisterProductSchema를 참조해 주십시오.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
PUT	/cw_fea/real/cw/api/schema

요청 헤더

Cloud Insight API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Insight 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`prodName`	String	Required	상품 이름 Cloud Insight 지표 참조
`cw_key`	String	Required	상품 키(cw_key) Cloud Insight 지표 참조
`fields`	Array	Required	사용자 정의 스키마

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request PUT 'https://cw.apigw.gov-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
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`msg`	String	-	응답 결과 메시지

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Insight API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "msg": "ok"
}