listImportedBackups

Prev Next

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

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

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

인증 주체가 보유한 Imported Backup 목록을 조회합니다. 응답에는 요약 필드만 포함되며 진행 단계(importProgress)는 제외됩니다. 정렬 가능 키는 name, importedDateTime, size이며 기본 정렬은 importedDateTime,desc입니다. 정렬 키가 고유하지 않은 경우 name 기준으로 안정 정렬합니다.

요청

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

메서드 URI
GET /imported-backups

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
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/imported-backups' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
importedBackups List<ImportedBackupSummary> - Imported Backup 요약 목록
pageNo Integer (int32) - 페이지 번호 (0부터 시작)
  • <예시> 0
pageSize Integer (int32) - 페이지 크기
  • <예시> 20
totalElements Integer (int32) - 전체 항목 수
  • <예시> 3
totalPages Integer (int32) - 전체 페이지 수
  • <예시> 1

ImportedBackupSummary

Imported Backup 요약 (목록 조회용)

필드 타입 필수 여부 설명
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
  • (읽기 전용)
engineVersion String - 백업을 생성한 DB 엔진 버전
  • <예시> 8.4.5
  • (읽기 전용)

응답 상태 코드

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

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

HTTP 상태 코드 코드 메시지 설명
200 - - Imported Backup 목록 (요약 필드, progress 제외)
400 InvalidParameter The specified parameter is invalid. 파라미터 값이 허용 범위나 형식을 벗어난 경우

응답 예시

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

{
  "importedBackups": [
    {
      "name": "import",
      "zoneCode": "KR-2",
      "size": 536870912,
      "status": "AVAILABLE",
      "importedDateTime": "2026-07-01T10:30:00Z",
      "engineVersion": "8.4.5"
    }
  ],
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 3,
  "totalPages": 1
}