GetRuleGroupByMetricGroupIds

Prev Next

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

Rule Template(監視項目グループ)に関連した Event Ruleを照会します。

リクエスト

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

メソッド URI
POST /cw_fea/real/cw/api/rule/group/metric/group/related

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
metricGroupIds Array Required Rule Template IDリスト

リクエスト例

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

curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/rule/group/metric/group/related?prodKey=**********' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '[
    "**********"
]'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

[
    {
        "id": "**********",
        "ruleGroupItemDtoList": [
            {
                "asgGroupOptions": {},
                "cfTriggers": [],
                "cfTriggersOptions": {},
                "classicAsgGroupOptions": {},
                "createTime": **********,
                "domainCode": "PUB",
                "groupDesc": "サーバイベントルールを変更します。",
                "groupName": "server-test",
                "id": "1061257530522611712",
                "metricsGroups": [
                    {
                        "createTime": **********,
                        "domainCode": "PUB",
                        "groupName": "test-server",
                        "id": "**********",
                        "idDimension": "instanceNo",
                        "metrics": [
                            {
                                "calculation": "AVG",
                                "condition": "EQ",
                                "desc": "disk write bytes average",
                                "dimensions": [
                                    {
                                        "dim": "type",
                                        "val": "svr"
                                    }
                                ],
                                "duration": 1,
                                "eventLevel": "INFO",
                                "metric": "avg_write_byt_cnt",
                                "metricGroupItemId": "**********",
                                "options": {
                                    "Min1": [
                                        "COUNT",
                                        "SUM",
                                        "MAX",
                                        "MIN",
                                        "AVG"
                                    ],
                                    "Min5": [
                                        "COUNT",
                                        "SUM",
                                        "MAX",
                                        "MIN",
                                        "AVG"
                                    ],
                                    "Min30": [
                                        "COUNT",
                                        "SUM",
                                        "MAX",
                                        "MIN",
                                        "AVG"
                                    ],
                                    "Hour2": [
                                        "COUNT",
                                        "SUM",
                                        "MAX",
                                        "MIN",
                                        "AVG"
                                    ],
                                    "Day1": [
                                        "COUNT",
                                        "SUM",
                                        "MAX",
                                        "MIN",
                                        "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": "**********",
                "recipientNotifications": [
                    {
                        "enableNotiWhenEventClose": false,
                        "groupName": "",
                        "groupNum": **********,
                        "notifyTypes": [
                            "SMS",
                            "EMAIL"
                        ]
                    }
                ],
                "regionCode": "KR",
                "ruleVersion": "V2",
                "suspendRuleItems": [
                    {
                        "metricGroupItemId": "**********",
                        "resourceId": "**********"
                    }
                ],
                "updateTime": **********
            }
        ]
    }
]