GetProductSchema
    • PDF

    GetProductSchema

    • PDF

    기사 요약

    개요

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

    요청

    API URL

    URL: https://cw.apigw.gov-ntruss.com/cw_fea/real/cw/api/schema
    Method: GET
    

    요청 헤더

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

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

    요청 파라미터

    파라미터에 prodName를 포함하여 요청하면 cw_key를 포함한 스키마를 리턴 받을 수 있습니다.

    파라미터명필수 여부타입제약사항설명
    cw_keyNString상품의 cw_key
    prodNameYString사용자 정의 스키마명은 Custom/으로 시작함상품의 이름

    예시

    요청 예시

    GET /cw_fea/real/cw/api/schema?prodName=Custom/MyProduct
    Host: cw.apigw.gov-ntruss.com
    x-ncp-apigw-signature-v2: {generated signature}
    x-ncp-apigw-timestamp: {current timestamp}
    x-ncp-iam-access-key: {your iam access key}
    

    응답 예시

    오류없이 조회가 완료된 경우 HTTP code 200과 해당 스키마가 JSON 형식으로 리턴됩니다.

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

    이 문서가 도움이 되었습니까?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.