listLogs

Prev Next

이 가이드는 API 명세를 기반으로 AI가 자동 생성했습니다.

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

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

인스턴스의 로그 파일 목록을 조회합니다. logType으로 유형을 필터링할 수 있으며, 현재 기록 중인 파일은 lastFile=true로 표시됩니다. 정렬 가능 키는 name, lastModifiedDateTime, fileSize이며 기본 정렬은 lastModifiedDateTime,desc입니다. 정렬 키가 고유하지 않은 경우 name 기준으로 안정 정렬합니다.

요청

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

메서드 URI
GET /clusters/{clusterName}/instances/{instanceName}/logs

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
clusterName String Required 클러스터 이름 (cluster의 name)
  • 패턴: ^[a-z0-9-]+$
  • 길이: 3 ~ 30
  • <예시> new-cluster
instanceName String Required 인스턴스 이름 ({clusterName}-{suffix} 형식)
  • 패턴: ^[a-z0-9-]+$
  • 길이: 3 ~ 39
  • <예시> new-cluster-28f07378

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
logType String Optional 로그 유형 필터 (생략 시 전체)
  • BIN | SLOW_QUERY | ERROR | GENERAL
  • <예시> SLOW_QUERY
pageNo Integer (int32) Optional 페이지 번호 (0부터 시작)
  • 범위: 0 ~
  • 기본값: 0
  • <예시> 0
pageSize Integer (int32) Optional 페이지 크기
  • 범위: 1 ~ 100
  • 기본값: 20
  • <예시> 20
sort List<String> Optional 정렬 기준 — <field>,<asc|desc> 형식. 반복 지정으로 다중 정렬. 허용 정렬 키와 기본 정렬 순서는 각 operation 설명 참고.
  • <예시> ["name,asc"]

요청 예시

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

curl --location --request GET 'https://clouddb-serverless.apigw.ntruss.com/mysql/v1/clusters/new-cluster/instances/new-cluster-28f07378/logs' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
logs List<Log> - 로그 파일 목록
pageNo Integer (int32) - 페이지 번호 (0부터 시작)
  • <예시> 0
pageSize Integer (int32) - 페이지 크기
  • <예시> 20
totalElements Integer (int32) - 전체 항목 수
  • <예시> 3
totalPages Integer (int32) - 전체 페이지 수
  • <예시> 1

Log

로그 파일

필드 타입 필수 여부 설명
name String - 이름
  • <예시> slow-query.log.1
logType String - 로그 파일의 유형
  • BIN | SLOW_QUERY | ERROR | GENERAL
  • <예시> SLOW_QUERY
fileSize Integer (int64) - 파일 크기 (bytes)
  • <예시> 1048576
lastModifiedDateTime String (date-time) - 로그 파일에 마지막으로 기록된 시각 (RFC3339 UTC)
  • <예시> 2026-07-01T12:00:00Z
lastFile Boolean - 현재 기록 중인 파일 여부
  • true | false
    • true: 현재 기록 중인 파일
    • false: 기록이 끝난 파일
  • <예시> true

응답 상태 코드

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

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드 코드 메시지 설명
200 - - 로그 파일 목록
400 InvalidParameter The specified parameter is invalid. 파라미터 값이 허용 범위나 형식을 벗어난 경우

응답 예시

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

{
  "logs": [
    {
      "name": "slow-query.log.1",
      "logType": "SLOW_QUERY",
      "fileSize": 1048576,
      "lastModifiedDateTime": "2026-07-01T12:00:00Z",
      "lastFile": true
    }
  ],
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 3,
  "totalPages": 1
}