listEvents

Prev Next

VPC 환경에서 이용 가능합니다.

Ncloud 표준 표현을 적용한 API입니다.

클러스터의 이벤트 이력을 조회합니다.

요청

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

메서드 URI
GET /mysql/v1/clusters/{clusterName}/events

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
clusterName String Required 클러스터 이름

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
filter String Optional 필터 표현식
  • 필터 대상
    • eventType | clusterDeleted | createdDateTime
      • eventType: 이벤트 유형. 연산자 =, 값 CLUSTER | DB | BACKUP | FAILOVER | ACCOUNT | SCALING_IN_OUT | SCALING_UP_DOWN
      • clusterDeleted: 클러스터 삭제 여부. 연산자 =, 값 true | false
      • createdDateTime: 이벤트 발생 일시. 연산자 >=, <=, 값 ISO 8601 형식 (UTC)
  • 값은 큰따옴표로 감싸서 입력
  • 조건은 AND로만 결합. 괄호 및 중첩 불가
  • 조건 최대 10개, 표현식 최대 1,024자
  • <예시> eventType="DB" AND createdDateTime>="2026-10-13T00:00:00Z"
pageNo Integer Optional 페이지 번호
  • 0~N (기본값: 0)
pageSize Integer Optional 페이지 크기
  • 1~100 (기본값: 20)
sort Array Optional 정렬 기준
  • 정렬 대상과 정렬 순서를 쉼표로 구분하여 입력
  • 정렬 대상
    • createdDateTime: 이벤트 발생 일시
  • 정렬 순서
    • asc | desc
      • asc: 오름차순
      • desc: 내림차순
  • 미입력 시 createdDateTime,desc
  • 여러 번 지정하면 다중 정렬

요청 예시

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

curl --location --request GET 'https://clouddb-serverless.apigw.ntruss.com/mysql/v1/clusters/test-cluster-01/events?pageNo=0&pageSize=20&sort=createdDateTime,asc' \
--get --data-urlencode 'filter=eventType="DB" AND createdDateTime>="2026-10-13T00:00:00Z"' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
events Array - 이벤트 목록: events
pageNo Integer - 페이지 번호
  • 0~N
pageSize Integer - 페이지 크기
  • 1~100
totalElements Integer - 전체 항목 수
totalPages Integer - 전체 페이지 수

events

events에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
createdDateTime String - 이벤트 발생 일시
  • ISO 8601 형식 (UTC)
message String - 이벤트 상세 메시지
eventType String - 이벤트 유형
  • CLUSTER | DB | BACKUP | FAILOVER | ACCOUNT | SCALING_IN_OUT | SCALING_UP_DOWN
    • CLUSTER: 클러스터 생성/복원/삭제
    • DB: DB 설정 및 Database 변경
    • BACKUP: 백업 생성/삭제/내보내기
    • FAILOVER: 자동 장애 조치
    • ACCOUNT: DB 사용자 계정 변경
    • SCALING_IN_OUT: Replica 인스턴스 수 변경
    • SCALING_UP_DOWN: 컴퓨팅 Unit 변경
clusterDeleted Boolean - 이벤트가 발생한 클러스터의 삭제 여부 (조회 시점 기준)
  • true | false
    • true: 삭제됨
    • false: 존재함

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드 코드 메시지 설명
200 - - 이벤트 이력
400 InvalidParameter The specified parameter is invalid. 파라미터 값이 허용 범위나 형식을 벗어난 경우
참고

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

응답 예시

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

{
  "events": [
    {
      "createdDateTime": "2026-10-13T10:35:00Z",
      "message": "Database modified",
      "eventType": "DB",
      "clusterDeleted": false
    },
    {
      "createdDateTime": "2026-10-13T10:40:00Z",
      "message": "User modified",
      "eventType": "ACCOUNT",
      "clusterDeleted": false
    },
    {
      "createdDateTime": "2026-10-13T10:45:00Z",
      "message": "Database modified",
      "eventType": "DB",
      "clusterDeleted": false
    }
  ],
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 16,
  "totalPages": 4
}