SearchMetricList

개요

감시대상 그룹에서 조회가능한 항목(metric) 리스트를 조회합니다.

요청

API URL

URL: https://cw.apigw.gov-ntruss.com/cw_fea/real/cw/api/rule/group/metric/search
Method: POST 

요청 헤더

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

Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

요청 바디

MetricListRequest

예시

요청 예시

아래는 cw_key가 "xxxxxxxxxxxxxxxxxx" 인 상품에서 조회조건이 다음과 같은 Metric을 조회하는 예시입니다.

• dimValues : Dimension 명이 "type" 이고 그 값이 "cpu"

• query : "used"라는 문자열이 포함되어 있는 Metric

• dimensionsSelectedList : Dimension "cpu_idx"의 값이 "0"이거나 "1"인 경우

POST /cw_fea/real/cw/api/rule/group/metric/search
Host: cw.apigw.gov-ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

Payload:
{
    "dimValues": [
        {
            "name": "type",
            "value": "cpu"
        }
    ],
    "query": "used",
    "dimensionsSelectedList": [
      {
        "name": "cpu_idx",
        "values": [
          "0",
          "1"
        ]
      }
    ],
    "prodKey": "xxxxxxxxxxxxxxxxxx"
}

응답 예시

{
  "metrics": [
    {
      "desc": "user ratio",
      "dimensions": [
        {
          "dim": "type",
          "val": "cpu"
        },
        {
          "dim": "cpu_idx",
          "val": "0"
        }
      ],
      "idDimension": "instanceNo",
      "metric": "used_rto",
      "options": {
        "Min1": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Min5": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Min30": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Hour2": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Day1": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ]
      },
      "prodKey": "xxxxxxxxxxxxxxxxxx",
      "unit": "%"
    },
    {
      "desc": "user ratio",
      "dimensions": [
        {
          "dim": "type",
          "val": "cpu"
        },
        {
          "dim": "cpu_idx",
          "val": "1"
        }
      ],
      "idDimension": "instanceNo",
      "metric": "used_rto",
      "options": {
        "Min1": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Min5": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Min30": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Hour2": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ],
        "Day1": [
          "COUNT",
          "SUM",
          "MAX",
          "MIN",
          "AVG"
        ]
      },
      "prodKey": "xxxxxxxxxxxxxxxxxx",
      "unit": "%"
    }
  ],
  "prodKey": "xxxxxxxxxxxxxxxxxx"
}