GetMetricsGroupList

Summary

This API queries all monitored item groups (templates) of a specified product.

Request

API URL

URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/rule/group/metrics/query/{prodKey}
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 all monitored item groups (templates) of the product with cw_key "xxxxxxxxxxxxxxxxxx".

GET /cw_fea/real/cw/api/rule/group/metrics/query/xxxxxxxxxxxxxxxxxx
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

{
    "metricsGroups": [
        {
            "createTime": 1589774843799,
            "domainCode": "PUB",
            "groupDesc": "The metric group (template) related to the server usage.",
            "groupName": "Server usage 002",
            "id": "monitorGrpId001",
            "metrics": [
                {
                    "calculation": "AVG",
                    "condition": "GT",
                    "dimensions": [
                        {
                            "dim": "type",
                            "val": "svr"
                        }
                    ],
                    "duration": 1,
                    "eventLevel": "INFO",
                    "metric": "avg_write_cnt",
                    "metricGroupItemId": "metricGroupItemId001",
                    "threshold": 0.7
                },
                {
                    "calculation": "AVG",
                    "condition": "GT",
                    "dimensions": [
                        {
                            "dim": "type",
                            "val": "svr"
                        }
                    ],
                    "duration": 1,
                    "eventLevel": "INFO",
                    "metric": "avg_cpu_used_rto",
                    "metricGroupItemId": "metricGroupItemId002",
                    "threshold": 1
                }
            ],
            "prodKey": "xxxxxxxxxxxxxxxxxx",
            "regionCode": "KR",
            "temporaryGroup": false,
            "updateTime": 1589774843799
        }
    ]
}