SearchEvent

Prev Next

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

Eventを照会します。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

Event照会時に必要なリクエスト情報関連フィールドの詳細は、EventSearchRequestをご参照ください。

リクエスト例

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

curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/event/search' \
--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 '{
    "endTime": "1702870800",
    "startTime": "1702867200"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
events Array - Event情報
pageNum Integer - ページ番号
pageSize Integer - ページ表示数
totalRecords Integer - レスポンス結果数

events

eventsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
calc String - 集計関数
  • COUNT | AVG | SUM | MAX | MIN
calcSlidingGroupKey String - Eventの詳細情報
criteria String - Event Ruleの値
describe String - Eventの説明
detectValue String - Eventの値
dimension Object - Dimension情報
dimension.instanceNo String - インスタンス番号
dimension.type String - Dimensionタイプ
endTime Integer - 照会終了日時(ミリ秒)
  • Unix Timestamp形式
eventId String - Event ID
eventLevel String - Eventレベル
  • INFO | WARNING | CRITICAL
inMaintenance Boolean - メンテナンスを設定するかどうか
  • true | false
    • true: 設定
    • false: 設定解除
interval Integer - 集計周期
  • Min1 | Min5 | Min30 | Hour2 | Day1
metric String - Metricの名前
metricGroupItemId String - Metric Group項目 ID
notificationGroups String - 通知対象グループの名前
notificationStatus String - 通知の状態
  • OK | FAIL | NONE
operator String - Event発生条件を評価するための比較演算子
  • LT | LE | EQ | GE | NE | EXP
operatorSymbol String - 比較演算子記号
prodKey String - 商品キー(cw_key)
prodName String - 商品名
regionCode String - リージョンコード
resourceDeleted Boolean - リソースを削除するかどうか
  • true | false
    • true: 削除
    • false: 削除しない
resourceName String - リソース名
ruleId String - Event Rule ID
ruleName String - Event Ruleの名前
startTime Integer - 照会開始時間(ミリ秒)
  • Unix Timestamp形式
unit String - Event単位
zoneCode String - ゾーンコード
pageNum Integer Required ページ番号
  • 1~N
pageSize Integer - Required
totalRecords Integer - レスポンス結果数

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

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

レスポンス例

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

{
    "events": [
        {
            "calc": "AVG",
            "calcSlidingGroupKey": "**********",
            "criteria": "0",
            "describe": "サーバイベントルール",
            "detectValue": "0.0",
            "dimension": {
                "instanceNo": "**********",
                "type": "svr"
            },
            "endTime": 0,
            "eventId": "**********",
            "eventLevel": "INFO",
            "inMaintenance": false,
            "interval": 1,
            "metric": "load_average_5m",
            "metricGroupItemId": "**********",
            "notificationGroups": "**********",
            "notificationStatus": "OK",
            "operator": "EQ",
            "operatorSymbol": "=",
            "prodKey": "**********",
            "prodName": "System/Server(VPC)",
            "regionCode": "KR",
            "resourceDeleted": false,
            "resourceName": "svr-pub",
            "ruleId": "**********",
            "ruleName": "rule001",
            "startTime": 1702867200,
            "unit": "%",
            "zoneCode": "KR-1"
        }
    ],
    "pageNum": 1,
    "pageSize": 20,
    "totalRecords": 15
}