UpdateProductSchema

개요

사용자가 정의한 스키마를 수정합니다.

요청

API URL

URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/schema
Method: PUT

요청 헤더

공통설정에 명시된 요청헤더가 필요합니다.

x-ncp-apigw-api-key: {your api gateway key}
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

요청 바디

파라미터명 필수 여부 타입 제약사항 설명
prodName Y String 상품의 이름
cw_key Y String 상품의 cw_key
fields Y List<FieldDto> 상품의 스키마 정의 (field array로 정의할 수 있습니다)

예시

요청 예시

PUT /cw_fea/real/cw/api/schema
Host: cw.apigw.ntruss.com
x-ncp-apigw-api-key: {your api gateway key}
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

Payload:

{
  "prodName": "Custom/MyProduct",
  "cw_key":"xxxxxxxxxxxxxxxxxx",
  "fields": [
    {
      "dataType": "STRING",
      "name": "dimensionName",
      "dimension": true,
      "metric": false,
      "counter": false,
      "idDimension": true|false,
      "defaultMetric": false,
      "desc": "description"
    },
    {
      "dataType": "STRING|INTEGER|FLOAT|LONG",
      "name": "metricName",
      "dimension": false,
      "metric": true,
      "counter": false,
      "defaultMetric": true|false,
      "desc": "description",
      "aggregations": {
        "Min30": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Hour2": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Min2": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Day1": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Min5": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Min1": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ]
      }
    }
  ]
}

참조: 스키마 등록과 업데이트 요청의 차이점은 이미 등록된 스키마의 cw_key가 필요하며 스키마를 업데이트 할 때 지정된 상품이 아직 없으면 오류가 리포트됩니다.

응답 예시

오류없이 업데이트가 완료된 경우 HTTP code 200과 간단한 JSON 형식의 응답이 리턴됩니다.

{
    "msg": "ok"
}