GetMetricsGroup

Summary

This API queries the detailed information of a monitored item group using the ID of the monitored item group (template).

Request

API URL

URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/rule/group/metrics/query/{prodKey}/{id}
Method: GET

Request header

The request headers specified in common settings are required.

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

Request Parameters

Example

Request example

The code below shows an example of querying a monitored item group with the ID "metricGroupId001" that is in the monitored item group (template) of the product with cw_key "xxxxxxxxxxxxxxxxxx".

GET /cw_fea/real/cw/api/rule/group/metrics/query/xxxxxxxxxxxxxxxxxx/metricGroupId001
Host: cw.apigw.ntruss.com
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

Response example

{
  "createTime": 1589769312574,
  "domainCode": "PUB",
  "groupDesc": "The metric group (template) related to the server usage.",
  "groupName": "Server usage",
  "id": "metricGroupId001",
  "idDimension": "instanceNo",
  "metrics": [
    {
      "calculation": "AVG",
      "condition": "GT",
      "dimensions": [
        {
          "dim": "type",
          "val": "svr"
        }
      ],
      "duration": 1,
      "eventLevel": "INFO",
      "metric": "avg_write_cnt",
      "metricGroupItemId": "metricGroupItemId001",
      "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"
        ]
      },
      "threshold": 0.7
    },
    {
      "calculation": "AVG",
      "condition": "GT",
      "dimensions": [
        {
          "dim": "type",
          "val": "svr"
        }
      ],
      "duration": 1,
      "eventLevel": "INFO",
      "metric": "avg_cpu_used_rto",
      "metricGroupItemId": "metricGroupItemId002",
      "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"
        ]
      },
      "threshold": 2
    }
  ],
  "prodKey": "xxxxxxxxxxxxxxxxxx",
  "prodType": "system",
  "regionCode": "KR",
  "temporaryGroup": false,
  "updateTime": 1589770306595
}