getImportedBackup

Prev Next

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

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

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

Imported Backup의 전체 필드를 조회합니다. 진행 단계(importProgress)와 실패 사유(error)를 포함합니다.

요청

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

메서드 URI
GET /imported-backups/{backupName}

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
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/imported-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}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
importedBackup Object<ImportedBackup> - Imported Backup

ImportedBackup

Object Storage에서 가져온 백업

필드 타입 필수 여부 설명
name String - 이름 (생성 후 변경 불가)
  • <예시> import
  • (읽기 전용)
zoneCode String - 백업이 저장된 존 코드
  • <예시> KR-2
  • (읽기 전용)
size Integer (int64) - 데이터 크기 (bytes)
  • <예시> 536870912
  • (읽기 전용)
status String - Import 상태
  • IMPORTING | AVAILABLE | FAILED
    • IMPORTING: 가져오기 진행 중인 상태
    • AVAILABLE: 복원에 사용 가능한 상태
    • FAILED: 가져오기에 실패한 상태
  • <예시> AVAILABLE
  • (읽기 전용)
importedDateTime String (date-time) - Import 완료 시각 (RFC3339 UTC)
  • <예시> 2026-07-01T10:30:00Z
  • (읽기 전용)
error Object<Error> | Null - 실패 사유 (status=FAILED일 때만). 표준 오류 객체(errorCode/message/detail).
  • (읽기 전용)
importProgress Object - Import 진행 상태 (5단계 고정)
  • (읽기 전용)
importProgress.currentStep Integer (int32) - 현재 단계
  • <예시> 2
importProgress.totalSteps Integer (int32) - 전체 단계 수
  • <예시> 5
importProgress.elapsedSeconds Integer (int32) - 경과 시간 (초)
  • <예시> 12
importProgress.steps List<Object> - 단계 목록
importProgress.steps[].step Integer (int32) - 단계 index (0부터)
  • <예시> 0
importProgress.steps[].name String - Import 단계 이름
  • DOWNLOAD | EXTRACT | VERIFY | CREATE_BACKUP | FINALIZE
    • DOWNLOAD: Object Storage에서 백업 파일 다운로드
    • EXTRACT: 백업 파일 압축 해제
    • VERIFY: 백업 파일 검증
    • CREATE_BACKUP: 복원용 백업 생성
    • FINALIZE: 마무리 처리
  • <예시> DOWNLOAD
importProgress.steps[].status String - 단계별 처리 상태
  • PENDING | IN_PROGRESS | COMPLETED | FAILED
    • PENDING: 시작 전 대기 상태
    • IN_PROGRESS: 처리 중인 상태
    • COMPLETED: 완료된 상태
    • FAILED: 실패한 상태
  • <예시> COMPLETED
engineVersion String - 백업을 생성한 DB 엔진 버전
  • <예시> 8.4.5
  • (읽기 전용)

Error

에러 정보

필드 타입 필수 여부 설명
errorCode String - 에러 코드
message String - 에러 메시지 (기본 영어, 다국어 지원 가능)
detail String - 에러 상세 정보 (기본 영어, 다국어 지원 가능)
fieldErrors List<FieldError> - 입력값 에러가 발생한 경우 각 필드별 에러 상세 정보 목록

FieldError

필드 에러 정보

필드 타입 필수 여부 설명
message String - 필드 에러 메시지 (기본 영어, 다국어 지원 가능)
field String - 입력값 검증 실패 시 해당 필드 이름

응답 상태 코드

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

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

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

응답 예시

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

{
  "importedBackup": {
    "name": "import",
    "zoneCode": "KR-2",
    "size": 536870912,
    "status": "AVAILABLE",
    "importedDateTime": "2026-07-01T10:30:00Z",
    "importProgress": {
      "currentStep": 2,
      "totalSteps": 5,
      "elapsedSeconds": 12,
      "steps": [
        {
          "step": 0,
          "name": "DOWNLOAD",
          "status": "COMPLETED"
        }
      ]
    },
    "engineVersion": "8.4.5"
  }
}