GetRuleGroup

Prev Next

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

特定の Event Ruleを照会します。

リクエスト

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

メソッド URI
GET /cw_fea/real/cw/api/rule/group/ruleGrp/query/{prodKey}/{id}

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
prodKey String Required 商品キー(cw_key)
id String Required Event Rule ID

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "ruleGroup": {
        "asgGroupOptions": {},
        "cfTriggers": [],
        "cfTriggersOptions": {},
        "classicAsgGroupOptions": {},
        "createTime": **********,
        "detailUrl": "/ci/rule/item/**********/**********",
        "domainCode": "PUB",
        "groupDesc": "サーバイベントルールを変更します。",
        "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": "監視対象グループのテスト",
                "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": **********
    }
}