이벤트 이력 조회

API의 이벤트 이력을 조회합니다.

요청

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

메서드	URI
POST	/api/v1/dashboards/events/search

요청 헤더

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

요청 구문

요청 구문은 다음과 같습니다.

{
  "offset" : 0,
  "level" : [ "level" ],
  "limit" : 0,
  "timeZone" : "timeZone",
  "from" : "from",
  "to" : "to",
  "type" : [ "type" ]
}

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`offset`	Long	Optional	조회할 데이터 목록에서 시작할 위치 0~9,223,372,036,854,775,807
`level`	List[String]	Optional	발생 이벤트 레벨 `EVENT` \| `ALARM` \| `ALERT` `EVENT`: 이벤트 `ALARM`: 알람 `ALERT`: 경고 컬렉션의 아이템은 null일 수 없음
`limit`	Long	Optional	한 번에 조회할 데이터 개수 1~9,223,372,036,854,775,807
`timeZone`	String	Required	타임 존(+09:00)
`from`	String	Required	조회 시작 일자 yyyy-MM-dd 형식
`to`	String	Required	조회 종료 일자 yyyy-MM-dd 형식
`type`	List[String]	Optional	발생 이벤트 유형 `ES010` \| `ES020` \| `EU400` \| `EU410` \| `EU420` `ES010`: 구독 요청(Subscription Request) `ES020`: 구독 상태 변경(Change Subscription's Status) `EU400`: 사용량 초과(Exceeded Quota) `EU410`: 초당 요청수 초과(Exceeded Throttle) `EU420`: 초당 사용량 초과(Exceeded Rate) 컬렉션의 아이템은 null일 수 없음

요청 예시

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

curl -X POST 'https://apigateway.apigw.fin-ntruss.com/api/v1/dashboards/events/search \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
  "offset" : 6,
  "level" : [ "EVENT" ],
  "limit" : 1,
  "timeZone" : "timeZone",
  "from" : "from",
  "to" : "to",
  "type" : [ "ES020" ]
}

응답

응답 형식을 설명합니다.

응답 구문

응답 구문은 다음과 같습니다.

{
    "events": {
        "content": [
            {
                "time": "2024-05-08 13:45:58",
                "level": "level",
                "type": "type",
                "message": "message"
            }
        ],
        "total": 0
    }
}

응답 상태 코드

API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 API Gateway 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "events": {
        "content": [
            {
                "time": "2024-05-08 13:45:58",
                "level": "EVENT",
                "type": "ES020",
                "message": "The status of subscription request for [test-***] requested by [apiKey-***] has been changed to [Accepted]."
            }
        ],
        "total": 1
    }
}

Documentation Index