SearchEventById

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

Event IDと Rule IDで Eventを照会します。

リクエスト

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

メソッド	URI
POST	/cw_fea/real/cw/api/event/searchById

リクエストヘッダ

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

リクエストボディ

Event IDで Eventを検索する際に必要なリクエスト情報関連フィールドの詳細は、EventSearchRequestByIdをご参照ください。

リクエスト例

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

curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/event/searchById' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "eventId": "**********",
	"ruleId": "**********"
}'

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`detectValue`	String	-	Eventの値
`inMaintenance`	Boolean	-	メンテナンスを設定するかどうか `true` \| `false` `true`: 設定 `false`: 設定解除
`prodKey`	String	-	商品キー(cw_key) Cloud Insight指標を参照
`criteria`	String	-	Event Ruleの値
`cycles`	Integer	-	Eventの終了状態 Event発生リソースが削除され、Eventが終了処理されたか確認する値 `0`: 終了していない (デフォルト) `1`: 終了
`metricGroupItemId`	String	-	Metric Group項目 ID
`operator`	String	-	Event発生条件を評価するための比較演算子 `LT` \| `LE` \| `EQ` \| `GE` \| `NE` \| `EXP`
`regionCode`	String	-	リージョンコード
`eventLevel`	String	-	Eventレベル `INFO` \| `WARNING` \| `CRITICAL`
`calcSlidingGroupKey`	String	-	Eventの詳細情報
`ruleName`	String	-	Event Ruleの名前
`startTime`	Integer	-	照会開始日時(ミリ秒) Unix Timestamp形式
`ruleId`	Integer	-	Event Rule ID
`eventId`	String	-	Event ID
`notificationGroups`	String	-	通知対象グループの名前
`unit`	String	-	Event単位
`metric`	String	-	Metricの名前
`eventCause`	String	-	Event発生の原因
`plannedMaintains`	String	-	メンテナンススケジュール
`interval`	String	-	集計周期 `Min1` \| `Min5` \| `Min30` \| `Hour2` \| `Day1`
`calc`	String	-	集計関数 `COUNT` \| `AVG` \| `SUM` \| `MAX` \| `MIN`
`describe`	String	-	Event Ruleの説明
`endTime`	Integer	-	照会終了日時(ミリ秒) Unix Timestamp形式
`zoneCode`	String	-	ゾーンコード
`dimensions`	Object	-	Dimensions情報
`dimensions.instanceNo`	String	-	インスタンス番号
`dimensions.type`	String	-	Dimensionsタイプ

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

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

レスポンス例

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

[
    {
        "detectValue": "0.01",
        "inMaintenance": false,
        "prodKey": "**********",
        "criteria": "0",
        "cycles": 0,
        "metricGroupItemId": "**********",
        "operator": "EQ",
        "regionCode": "KR",
        "eventLevel": "INFO",
        "calcSlidingGroupKey": "**********",
        "ruleName": "server-test",
        "startTime": **********,
        "ruleId": **********,
        "eventId": "**********",
        "notificationGroups": "**********",
        "unit": "%",
        "metric": "load_average_5m",
        "eventCause": "RULE_EVENT",
        "plannedMaintains": "[]",
        "interval": "1",
        "calc": "AVG",
        "describe": "サーバイベントルール",
        "endTime": **********,
        "zoneCode": "KR-1",
        "dimensions": {
            "instanceNo": "**********",
            "type": "svr"
        }
    }
]