MENU
      GetRuleGroupList

        GetRuleGroupList


        Article summary

        Available in Classic and VPC

        Get the list of all event rules.

        Request

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

        MethodURI
        POST/cw_fea/real/cw/api/rule/group/ruleGrp/query

        Request headers

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

        Request body

        You can include the following data in the body of your request:

        FieldTypeRequiredDescription
        prodKeyStringRequiredProduct key (cw_key)
        pageSizeIntegerRequiredPage output count
        pageNumIntegerRequiredPage number
        searchStringOptionalQuery keyword

        Request example

        The request example is as follows:

        curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/rule/group/ruleGrp/query' \
        --header 'x-ncp-iam-access-key: {x-ncp-iam-access-key}' \
        --header 'x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}' \
        --header 'x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}' \
        --header 'Content-Type: application/json' \
        --data '{
            "prodKey": "**********",
            "pageSize": 3,
            "pageNum": 1,
            "search": ""
        }'
        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:

        {
            "pageNum": 1,
            "pageSize": 3,
            "ruleGroups": [
                {
                    "cfTriggers": [],
                    "cfTriggersOptions": {},
                    "createTime": **********,
                    "detailUrl": "**********",
                    "domainCode": "PUB",
                    "groupDesc": "Create an event rule for 20241202.",
                    "groupName": "20241202-createRuleGroup",
                    "id": "**********",
                    "metrics": [],
                    "metricsGroups": [
                        {
                            "createTime": **********,
                            "domainCode": "PUB",
                            "groupDesc": "This is a metric group (template) for server usage as of 20241202.",
                            "groupName": "20241202 - server usage",
                            "id": "**********",
                            "idDimension": "resourceId",
                            "metrics": [
                                {
                                    "calculation": "AVG",
                                    "condition": "GT",
                                    "dimensions": [
                                        {
                                            "dim": "type",
                                            "val": "svr"
                                        }
                                    ],
                                    "duration": 1,
                                    "eventLevel": "INFO",
                                    "metric": "bucket_size",
                                    "metricGroupItemId": "**********",
                                    "options": {
                                        "Min1": [
                                            "AVG"
                                        ],
                                        "Min5": [
                                            "AVG"
                                        ],
                                        "Min30": [
                                            "AVG"
                                        ],
                                        "Hour2": [
                                            "AVG"
                                        ],
                                        "Day1": [
                                            "AVG"
                                        ]
                                    },
                                    "threshold": "1"
                                }
                            ],
                            "prodKey": "**********",
                            "prodType": "system",
                            "regionCode": "KR",
                            "temporaryGroup": false,
                            "updateTime": **********
                        }
                    ],
                    "monitorGroups": [
                        {
                            "groupDesc": "20241202 API creation test",
                            "groupName": "test",
                            "id": "**********",
                            "monitorGroupItemList": [
                                {
                                    "nrn": "**********",
                                    "resourceId": "**********",
                                    "resourceName": "**********"
                                }
                            ],
                            "prodKey": "**********",
                            "prodName": "Object Storage",
                            "temporaryGroup": false,
                            "type": "NORMAL"
                        }
                    ],
                    "prodKey": "**********",
                    "prodType": "system",
                    "productName": "Object Storage",
                    "regionCode": "KR",
                    "ruleVersion": "V2",
                    "suspendRuleItems": [],
                    "updateTime": **********
                }
            ],
            "totalPages": 2,
            "totalRecords": 4
        }
        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.