SearchMetricList

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

감시 대상 그룹에서 Metric 목록을 조회합니다.

요청

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

메서드	URI
POST	/cw_fea/real/cw/api/rule/group/metric/search

요청 헤더

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

요청 바디

Metric 정보 관련 필드에 대한 설명은 MetricListRequest를 참조해 주십시오.

요청 예시

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

curl --location --request POST 'https://cw.apigw.gov-ntruss.com/cw_fea/real/cw/api/rule/group/metric/search' \
--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 '{
    "dimValues": [
        {
            "name": "type",
            "value": "cpu"
        }
    ],
    "query": "used",
    "dimensionsSelectedList": [
      {
        "name": "cpu_idx",
        "values": [
          "0",
          "1"
        ]
      }
    ],
    "prodKey": "**********"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`metrics`	Array	-	Metric 목록
`prodKey`	String	Required	상품 키(cw_key) Cloud Insight 지표 참조

`metrics`

metrics에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`dataType`	String	-	데이터 타입
`desc`	String	-	Metric 설명
`dimensions`	Array	-	Dimension 목록
`idDimension`	String	-	Dimension 이름
`metric`	String	-	Metric 이름
`options`	Object	-	집계 방법 `"집계 주기": [집계 함수]` 형태로 표시 집계 주기: `Min1` \| `Min5` \| `Min30` \| `Hour2` \| `Day1` 집계 함수: `COUNT` \| `SUM` \| `MAX` \| `MIN` \| `AVG`
`prodKey`	String	Required	상품 키(cw_key) Cloud Insight 지표 참조
`unit`	String	-	단위

`dimensions`

dimensions에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`dim`	String	-	Dimension 이름
`val`	String	-	Dimension 값

응답 상태 코드

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

응답 예시

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

{
  "metrics": [
    {
      "dataType": "FLOAT",
      "desc": "used 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": "**********",
      "unit": "%"
    },
    {
      "dataType": "FLOAT",
      "desc": "used 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": "**********",
      "unit": "%"
    }
  ],
  "prodKey": "**********"
}