SearchEvent

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.gov-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 아이디
`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 항목 아이디
`notificationGroups`	String	-	통보 대상 그룹 이름
`notificationStatus`	String	-	통보 상태 `OK` \| `FAIL` \| `NONE`
`operator`	String	-	Event 발생 조건을 평가하기 위한 비교 연산자 `LT` \| `LE` \| `EQ` \| `GE` \| `NE` \| `EXP`
`operatorSymbol`	String	-	비교 연산자 기호
`prodKey`	String	-	상품 키(cw_key) Cloud Insight 지표 참조
`prodName`	String	-	상품 이름 Cloud Insight 지표 참조
`regionCode`	String	-	리전 코드
`resourceDeleted`	Boolean	-	리소스 삭제 여부 `true` \| `false` `true`: 삭제 `false`: 삭제 안 함
`resourceName`	String	-	리소스 이름
`ruleId`	String	-	Event Rule 아이디
`ruleName`	String	-	Event Rule 이름
`startTime`	Integer	-	조회 시작 시간(밀리초) Unix Timestamp 형식
`unit`	String	-	Event 단위
`zoneCode`	String	-	존 코드
`pageNum`	Integer	Required	페이지 번호 1~N
`pageSize`	Integer	-	Required
`totalRecords`	Integer	-	응답 결과 수

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 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
}