GetRuleGroupList

Classic/VPC環境で利用できます。

全 Event Ruleリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

Cloud Insight APIで共通して使用されるヘッダの詳細は、Cloud Insightのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

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": ""
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

Event Rule情報関連フィールドの詳細は、RuleGroupItemDtoをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Cloud Insight APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "pageNum": 1,
    "pageSize": 3,
    "ruleGroups": [
        {
            "cfTriggers": [],
            "cfTriggersOptions": {},
            "createTime": **********,
            "detailUrl": "**********",
            "domainCode": "PUB",
            "groupDesc": "20241202イベントルールを作成します。",
            "groupName": "20241202-createRuleGroup",
            "id": "**********",
            "metrics": [],
            "metricsGroups": [
                {
                    "createTime": **********,
                    "domainCode": "PUB",
                    "groupDesc": "20241202サーバ使用量に対する Metric Group(template)です。",
                    "groupName": "20241202-サーバ使用量",
                    "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作成テスト",
                    "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
}