MENU
      SearchEventById

        SearchEventById


        Article summary

        Available in Classic and VPC

        Get an event by its event ID and rule ID.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        POST/cw_fea/real/cw/api/event/searchById

        Request headers

        For information about the headers common to all Cloud Insight APIs, see Cloud Insight request headers.

        Request body

        See EventSearchRequestById for more information about the fields related to the request information required when searching events with the event ID.

        Request example

        The request example is as follows:

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

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        detectValueString-Event value
        inMaintenanceBoolean-Whether to set maintenance
        • true | false
          • true: set
          • false: not set
        prodKeyString-Product key (cw_key)
        criteriaString-Event rule value
        cyclesInteger-Event termination status
        • A value that confirms whether the event has been terminated by deleting the event-triggering resource
        • 0: not terminated (default)
        • 1: terminated
        metricGroupItemIdString-Metric group item ID
        operatorString-Comparison operator for evaluating event occurrence conditions
        • LT | LE | EQ | GE | NE | EXP
        regionCodeString-Region code
        eventLevelString-Event level
        • INFO | WARNING | CRITICAL
        calcSlidingGroupKeyString-Event details
        ruleNameString-Name of event rule
        startTimeInteger-Query start date and time (millisecond)
        • Unix timestamp format
        ruleIdInteger-Event rule ID
        eventIdString-Event ID
        notificationGroupsString-Notification recipient group name
        unitString-Event unit
        metricString-Metric name
        eventCauseString-Event occurrence cause
        plannedMaintainsString-Maintenance schedule
        intervalString-Aggregation interval
        • Min1 | Min5 | Min30 | Hour2 | Day1
        calcString-Aggregation function
        • COUNT | AVG | SUM | MAX | MIN
        describeString-Description of event rule
        endTimeInteger-Query end date and time (millisecond)
        • Unix timestamp format
        zoneCodeString-Zone code
        dimensionsObject-Dimensions information
        dimensions.instanceNoString-Instance number
        dimensions.typeString-Dimensions type

        Response status codes

        For response status codes common to NAVER Cloud Platform, see Cloud Insight API response status codes.

        Response example

        The response example is as follows:

        [
            {
                "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": "Server event rule",
                "endTime": **********,
                "zoneCode": "KR-1",
                "dimensions": {
                    "instanceNo": "**********",
                    "type": "svr"
                }
            }
        ]
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.