MENU
      SearchEvent

        SearchEvent


        Article summary

        Available in Classic and VPC

        This API queries events.

        Request

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

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

        Request headers

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

        Request body

        See EventSearchRequest for more information about the fields related to the request information required when querying events.

        Request example

        The request example is as follows:

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

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        eventsArray-Event information
        pageNumInteger-Page number
        pageSizeInteger-Page output count
        totalRecordsInteger-Number of response results

        events

        The following describes events.

        FieldTypeRequiredDescription
        calcString-Aggregation function
        • COUNT | AVG | SUM | MAX | MIN
        calcSlidingGroupKeyString-Event details
        criteriaString-Event rule value
        describeString-Event description
        detectValueString-Event value
        dimensionObject-Dimension information
        dimension.instanceNoString-Instance number
        dimension.typeString-Dimension type
        endTimeInteger-Query end date and time (millisecond)
        • Unix timestamp format
        eventIdString-Event ID
        eventLevelString-Event level
        • INFO | WARNING | CRITICAL
        inMaintenanceBoolean-Whether to set maintenance
        • true | false
          • true: set
          • false: not set
        intervalInteger-Aggregation interval
        • Min1 | Min5 | Min30 | Hour2 | Day1
        metricString-Metric name
        metricGroupItemIdString-Metric group item ID
        notificationGroupsString-Notification recipient group name
        notificationStatusString-Notification status
        • OK | FAIL | NONE
        operatorString-Comparison operator for evaluating event occurrence conditions
        • LT | LE | EQ | GE | NE | EXP
        operatorSymbolString-Comparison operator symbol
        prodKeyString-Product key (cw_key)
        prodNameString-Product name
        regionCodeString-Region code
        resourceDeletedBoolean-Resource deletion status
        • true | false
          • true: delete
          • false: not delete
        resourceNameString-Resource name
        ruleIdString-Event rule ID
        ruleNameString-Name of event rule
        startTimeInteger-Query start time (millisecond)
        • Unix timestamp format
        unitString-Event unit
        zoneCodeString-Zone code
        pageNumIntegerRequiredPage number
        • 1 - N
        pageSizeInteger-Required
        totalRecordsInteger-Number of response results

        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:

        {
            "events": [
                {
                    "calc": "AVG",
                    "calcSlidingGroupKey": "**********",
                    "criteria": "0",
                    "describe": "Server event rule",
                    "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
        }
        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.