getImportedBackup

Prev Next

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

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

Imported Backup의 상세 정보를 조회합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
backupName String Required Imported Backup 이름

요청 예시

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

curl --location --request GET 'https://clouddb-serverless.apigw.ntruss.com/mysql/v1/imported-backups/test-import-01' \
--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 - Imported Backup 상세 정보
importedBackup.name String - Imported Backup 이름
importedBackup.zoneCode String - 백업이 저장된 존 코드
importedBackup.size Integer - 데이터 크기 (Byte)
importedBackup.status String - Import 상태
  • IMPORTING | AVAILABLE | FAILED
    • IMPORTING: 가져오기 진행 중인 상태
    • AVAILABLE: 복원에 사용 가능한 상태
    • FAILED: 가져오기에 실패한 상태
importedBackup.importedDateTime String - Import 완료 일시
  • ISO 8601 형식 (UTC)
importedBackup.error Object - 실패 사유
  • Error와 동일한 형식
  • 가져오기에 실패한 경우에 반환
importedBackup.importProgress Object - Import 진행 상태
importedBackup.importProgress.currentStep Integer - 현재 단계
importedBackup.importProgress.totalSteps Integer - 전체 단계 수
importedBackup.importProgress.elapsedSeconds Integer - 경과 시간 (초)
importedBackup.importProgress.steps Array - Import 단계별 상태: steps
importedBackup.engineVersion String - 백업을 생성한 DB 엔진 버전

steps

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

필드 타입 필수 여부 설명
step Integer - Import 단계 인덱스
  • 0~4 (총 5단계)
name String - Import 단계 이름
  • DOWNLOAD | EXTRACT | VERIFY | CREATE_BACKUP | FINALIZE
    • DOWNLOAD: Object Storage에서 백업 파일 다운로드
    • EXTRACT: 백업 파일 압축 해제
    • VERIFY: 백업 파일 검증
    • CREATE_BACKUP: 복원용 백업 생성
    • FINALIZE: 마무리 처리
status String - Import 단계별 처리 상태
  • PENDING | IN_PROGRESS | COMPLETED | FAILED
    • PENDING: 시작 전 대기 상태
    • IN_PROGRESS: 처리 중인 상태
    • COMPLETED: 완료된 상태
    • FAILED: 실패한 상태

응답 상태 코드

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

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

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

응답 예시

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

{
  "importedBackup": {
    "name": "test-import-01",
    "zoneCode": "KR-1",
    "size": 736828206,
    "status": "AVAILABLE",
    "importedDateTime": "2026-10-13T11:55:00Z",
    "engineVersion": "8.4.5",
    "importProgress": {
      "currentStep": 4,
      "totalSteps": 5,
      "elapsedSeconds": 184,
      "steps": [
        {
          "step": 0,
          "name": "DOWNLOAD",
          "status": "COMPLETED"
        },
        {
          "step": 1,
          "name": "EXTRACT",
          "status": "COMPLETED"
        },
        {
          "step": 2,
          "name": "VERIFY",
          "status": "COMPLETED"
        },
        {
          "step": 3,
          "name": "CREATE_BACKUP",
          "status": "COMPLETED"
        },
        {
          "step": 4,
          "name": "FINALIZE",
          "status": "COMPLETED"
        }
      ]
    }
  }
}