Documentation Index

Fetch the complete documentation index at: https://api-fin.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

SearchEventById

Prev Next

Event 아이디와 Rule 아이디로 Event를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /cw_fea/real/cw/api/event/searchById

요청 헤더

Cloud Insight API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Insight 요청 헤더를 참조해 주십시오.

요청 바디

Event 아이디로 Event 검색 시 필요한 요청 정보 관련 필드에 대한 설명은 EventSearchRequestById를 참조해 주십시오.

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://cw.apigw.fin-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)
criteria String - Event Rule 값
cycles Integer - Event 종료 상태
  • Event 발생 리소스가 삭제되어 Event가 종료 처리됐는지 확인하는 값
  • 0: 종료 안 됨 (기본값)
  • 1: 종료
metricGroupItemId String - Metric Group 항목 아이디
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 아이디
eventId String - Event 아이디
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 유형

응답 상태 코드

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