getBackup

Prev Next

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

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

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

지정한 백업의 상태·크기·생성 시각을 조회합니다. 응답 스키마는 목록 조회와 같으며, 이름을 알고 있는 백업 하나의 최신 상태를 페이지 조회 없이 확인할 때 사용합니다. 백업은 Cloud DB Serverless가 자동 생성하며 수동 생성/삭제는 제공하지 않습니다.

요청

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

메서드 URI
GET /clusters/{clusterName}/backups/{backupName}

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
clusterName String Required 클러스터 이름 (cluster의 name)
  • 패턴: ^[a-z0-9-]+$
  • 길이: 3 ~ 30
  • <예시> new-cluster
backupName String Required Cloud DB Serverless가 생성한 백업 이름. {clusterName}-{yyyyMMddHHmmss} 형식이며 시각은 UTC 기준
  • 패턴: ^[a-z0-9-]+$
  • 길이: 3 ~ 45
  • <예시> my-cluster-20260721103000

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
backup Object<Backup> - 백업 상세 정보

Backup

클러스터 백업 (자동 생성)

필드 타입 필수 여부 설명
name String - 이름
  • <예시> backup-20260721
zoneCode String - 백업이 저장된 존 코드
  • <예시> KR-1
status String - 백업 상태
  • CREATING | AVAILABLE | IN_USE | DELETING
    • CREATING: 백업 생성 중인 상태
    • AVAILABLE: 복원 등에 사용 가능한 상태
    • IN_USE: 복원·내보내기 작업에 사용 중이라 삭제할 수 없는 상태
    • DELETING: 삭제 중인 상태
  • <예시> AVAILABLE
size Integer (int64) - 백업 크기 (bytes)
  • <예시> 536870912
createdDateTime String (date-time) - 백업 생성 시각 (RFC3339 UTC)
  • <예시> 2026-07-01T09:00:00Z

응답 상태 코드

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

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

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

응답 예시

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

{
  "backup": {
    "name": "backup-20260721",
    "zoneCode": "KR-1",
    "status": "AVAILABLE",
    "size": 536870912,
    "createdDateTime": "2026-07-01T09:00:00Z"
  }
}