GetRuleGroup
    • PDF

    GetRuleGroup

    • PDF

    Article summary

    Summary

    This API queries an event rule.

    Request

    API URL

    URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/rule/group/ruleGrp/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

    Parameter NameRequirement statusTypeRestrictionsDescription
    prodKeyYStringcw_key of the product with which the event rule is associated
    idYStringEvent Rule id

    Example

    Request example

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

    {
        "ruleGroup": {
            "createTime": 1589776027701,
            "domainCode": "PUB",
            "groupDesc": "Creates an event rule.",
            "groupName": "eventRule001",
            "id": "eventRuleId001",
            "metricsGroups": [
                {
                    "createTime": 1589769312574,
                    "domainCode": "PUB",
                    "groupDesc": "The metric group (template) related to the server usage.",
                    "groupName": "Server usage",
                    "id": "metricGroupId001",
                    "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": 2
                        }
                    ],
                    "prodKey": "xxxxxxxxxxxxxxxxxx",
                    "regionCode": "KR",
                    "temporaryGroup": false,
                    "updateTime": 1589770306595
                }
            ],
            "monitorGroups": [
                {
                    "groupDesc": "Creates a monitor group.",
                    "groupName": "monitorGrp001",
                    "id": "monitorGrpId001",
                    "monitorGroupItemList": [
                        {
                            "nrn": "targetNRN001",
                            "resourceId": "targetId001"
                        }
                    ],
                    "prodKey": "xxxxxxxxxxxxxxxxxx",
                    "temporaryGroup": false
                }
            ],
            "prodKey": "xxxxxxxxxxxxxxxxxx",
            "productName": "System/Server",
            "recipientNotifications": [
                {
                    "groupName": "Recipient group",
                    "groupNum": xx,
                    "notifyTypes": [
                        "SMS",
                        "EMAIL"
                    ]
                }
            ],
            "regionCode": "KR",
            "ruleVersion": "V2",
            "updateTime": 1589776027701
        }
    }
    

    Was this article helpful?

    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.