MENU
      GetRuleGroup

        GetRuleGroup


        Article summary

        Available in Classic and VPC

        Get a specific event rule.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        GET/cw_fea/real/cw/api/rule/group/ruleGrp/query/{prodKey}/{id}

        Request headers

        For information about the headers common to all Cloud Insight APIs, see Cloud Insight request headers.

        Request path parameters

        You can use the following path parameters with your request:

        FieldTypeRequiredDescription
        prodKeyStringRequiredProduct key (cw_key)
        idStringRequiredEvent rule ID

        Request example

        The request example is as follows:

        curl --location --request GET 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/rule/group/ruleGrp/query/**************/*********' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Shell

        Response

        This section describes the response format.

        Response body

        For more information on the fields related to the event rule information, see RuleGroupItemDto.

        Response status codes

        For response status codes common to NAVER Cloud Platform, see Cloud Insight API response status codes.

        Response example

        The response example is as follows:

        {
            "ruleGroup": {
                "asgGroupOptions": {},
                "cfTriggers": [],
                "cfTriggersOptions": {},
                "classicAsgGroupOptions": {},
                "createTime": **********,
                "detailUrl": "/ci/rule/item/**********/**********",
                "domainCode": "PUB",
                "groupDesc": "Edit server event rule.",
                "groupName": "server-test",
                "id": "**********",
                "metricsGroups": [
                    {
                        "createTime": **********,
                        "domainCode": "PUB",
                        "groupName": "test-server",
                        "id": "**********",
                        "idDimension": "instanceNo",
                        "metrics": [
                            {
                                "calculation": "AVG",
                                "condition": "EQ",
                                "desc": "0:agent active, no ping check. 1:data not collected in recent 3 minutes, ping server success. 2:data not collected in recent 3 minutes, ping server fail.",
                                "dimensions": [
                                    {
                                        "dim": "type",
                                        "val": "svr"
                                    }
                                ],
                                "duration": 1,
                                "eventLevel": "INFO",
                                "metric": "agent_status",
                                "metricGroupItemId": "**********",
                                "options": {
                                    "Min1": [
                                        "AVG"
                                    ]
                                },
                                "threshold": "0"
                            },
                            {
                                "calculation": "AVG",
                                "condition": "EQ",
                                "desc": "user count",
                                "dimensions": [
                                    {
                                        "dim": "type",
                                        "val": "svr"
                                    }
                                ],
                                "duration": 1,
                                "eventLevel": "INFO",
                                "metric": "user_cnt",
                                "metricGroupItemId": "**********",
                                "options": {
                                    "Min1": [
                                        "AVG"
                                    ]
                                },
                                "threshold": "0"
                            }
                        ],
                        "prodKey": "**********",
                        "prodType": "system",
                        "regionCode": "KR",
                        "temporaryGroup": false,
                        "updateTime": **********
                    }
                ],
                "monitorGroups": [
                    {
                        "groupDesc": "Monitoring target group test",
                        "groupName": "test-group",
                        "id": "**********",
                        "monitorGroupItemList": [
                            {
                                "nrn": "**********",
                                "resourceId": "**********",
                                "resourceName": "****"
                            }
                        ],
                        "prodKey": "**********",
                        "prodName": "Server(VPC)",
                        "temporaryGroup": false,
                        "type": "NORMAL"
                    }
                ],
                "prodKey": "**********",
                "prodType": "system",
                "productName": "Server(VPC)",
                "recipientNotifications": [
                    {
                        "enableNotiWhenEventClose": false,
                        "groupName": "test-nr",
                        "groupNum": 8168,
                        "notifyTypes": [
                            "SMS",
                            "EMAIL"
                        ]
                    }
                ],
                "regionCode": "KR",
                "ruleVersion": "V2",
                "suspendRuleItems": [
                    {
                        "metricGroupItemId": "**********",
                        "resourceId": "**********"
                    }
                ],
                "updateTime": **********
            }
        }
        JSON

        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.