listImportedBackups

Prev Next

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

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

Imported Backup 목록을 조회합니다.

요청

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

메서드 URI
GET /mysql/v1/imported-backups

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
pageNo Integer Optional 페이지 번호
  • 0~N (기본값: 0)
pageSize Integer Optional 페이지 크기
  • 1~100 (기본값: 20)
sort Array Optional 정렬 기준
  • 정렬 대상과 정렬 순서를 쉼표로 구분하여 입력
  • 정렬 대상
    • name | importedDateTime | size
      • name: Imported Backup 이름
      • importedDateTime: Import 완료 일시
      • size: 데이터 크기 (Byte)
  • 정렬 순서
    • asc | desc
      • asc: 오름차순
      • desc: 내림차순
  • 미입력 시 importedDateTime,desc
  • 정렬 키 값이 같으면 name 순으로 정렬
  • 여러 번 지정하면 다중 정렬

요청 예시

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

curl --location --request GET 'https://clouddb-serverless.apigw.ntruss.com/mysql/v1/imported-backups?pageNo=0&pageSize=20&sort=name,asc' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
importedBackups Array - Imported Backup 요약 목록: importedBackups
pageNo Integer - 페이지 번호
  • 0~N
pageSize Integer - 페이지 크기
  • 1~100
totalElements Integer - 전체 항목 수
totalPages Integer - 전체 페이지 수

importedBackups

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

필드 타입 필수 여부 설명
name String - Imported Backup 이름
zoneCode String - 백업이 저장된 존 코드
size Integer - 데이터 크기 (Byte)
status String - Import 상태
  • IMPORTING | AVAILABLE | FAILED
    • IMPORTING: 가져오기 진행 중인 상태
    • AVAILABLE: 복원에 사용 가능한 상태
    • FAILED: 가져오기에 실패한 상태
importedDateTime String - Import 완료 일시
  • ISO 8601 형식 (UTC)
engineVersion String - DB 엔진 버전

응답 상태 코드

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

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

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

응답 예시

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

{
  "importedBackups": [
    {
      "name": "test-import-01",
      "zoneCode": "KR-1",
      "size": 736828206,
      "status": "AVAILABLE",
      "importedDateTime": "2026-10-13T11:55:00Z",
      "engineVersion": "8.4.5"
    }
  ],
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 1,
  "totalPages": 1
}