getLogConfig

Prev Next

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

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

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

클러스터의 로그 로테이션 설정을 logType별로 조회합니다.

요청

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

메서드 URI
GET /clusters/{clusterName}/log-config

요청 헤더

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

요청 경로 파라미터

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

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

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
logConfig Object<LogConfig> - 로그 로테이션 설정

LogConfig

로그 로테이션 설정 (logType별)

필드 타입 필수 여부 설명
rotations Map<Object> - 로그 유형(logType)을 키로 하는 로테이션 설정 Map. 전달한 키만 변경

rotations

필드 타입 필수 여부 설명
rotationType String - 로테이션 기준
  • DAILY | SIZE
    • DAILY: 일 단위로 로테이션
    • SIZE: 파일 크기(MiB) 기준으로 로테이션 (megaBytes 필수)
  • <예시> DAILY
fileCount Integer (int32) - 보관 파일 수
  • 범위: 3 ~ 10
  • <예시> 7
megaBytes Integer (int32) | null - 크기 기준 (MiB) — rotationType=SIZE 시 필수이며, rotationType=DAILY이면 null
  • 범위: 10 ~ 100
  • 10의 배수

응답 상태 코드

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

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

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

응답 예시

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

{
  "logConfig": {
    "rotations": {
      "key": {
        "rotationType": "DAILY",
        "fileCount": 7
      }
    }
  }
}