createImportedBackup

Prev Next

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

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

Object Storage에 있는 백업 파일을 가져와 Imported Backup을 비동기로 생성합니다.

참고

가져올 백업 파일이 Object Storage 버킷에 업로드되어 있어야 합니다. 버킷 생성 방법은 Object Storage 사용 가이드를 참조해 주십시오.

요청

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

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

요청 헤더

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
name String Required Imported Backup 이름
  • 영문 소문자, 숫자, 특수문자 -를 조합하여 3~30자 이내로 입력
  • 문자열의 시작과 끝에 - 사용 불가
  • 엔진 내에서 중복 불가
bucketName String Required 백업 파일이 있는 소스 Object Storage 버킷 이름
objectPath String Required 버킷 내 백업 파일의 전체 경로 (파일 이름 포함)
  • 영문자, 숫자, 특수문자 ., _, /, - 사용
  • 파일 크기 최대 16 TiB
  • ListObjects 참조
zoneCode String Optional 백업을 저장할 존 코드
  • 미입력 시 첫 번째 가용 존에 저장
  • getZoneList 참조
engineVersion String Required 백업을 생성한 DB 엔진 버전

요청 예시

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

curl --location --request POST '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}' \
--header 'Content-Type: application/json' \
--data '{
  "name": "test-import-01",
  "bucketName": "test-bucket",
  "objectPath": "backups/test-cluster-01-20261013112000-20261013114500.tar",
  "zoneCode": "KR-1",
  "engineVersion": "8.4.5"
}'

응답

응답 형식을 설명합니다.

응답 헤더

응답 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
retry-after - 권장 폴링 간격 (초)
  • done이 false인 동안 이 간격으로 진행 상태 조회
  • 202 응답에 포함

응답 바디

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

필드 타입 필수 여부 설명
id String - Operation 식별자
done Boolean - 완료 여부
  • true | false
    • true: 완료
    • false: 진행 중
metadata Object - Operation 부가 정보
metadata.operationType String - 작업 유형
  • CREATE | UPDATE | DELETE
    • CREATE: 생성
    • UPDATE: 변경
    • DELETE: 삭제
metadata.resourceType String - 대상 리소스
  • REST 경로의 리소스 세그먼트와 일치
  • <예시> imported-backups
metadata.startDateTime String - 작업 시작 일시
  • ISO 8601 형식 (UTC)
metadata.endDateTime String - 작업 완료 일시
  • ISO 8601 형식 (UTC)
  • 진행 중이면 null 반환
metadata.progress Integer - 진행률 (%)
  • 0~100
  • 제공 가능한 작업에 한해 반환
  • 완료 후 미반환
results Object - 성공 결과
  • 요청 인덱스를 키로 하는 객체. 단건 작업은 0 키 하나를 사용
  • 클러스터 작업에서만 값을 반환하며, 그 외 작업은 null 반환
error Object - 실패 사유
  • Error와 동일한 형식
  • 작업이 실패한 경우에 반환

응답 상태 코드

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

HTTP 상태 코드 코드 메시지 설명
400 InvalidParameter The specified parameter is invalid. 파라미터 값이 허용 범위나 형식을 벗어난 경우
400 InvalidState Indicates that the specified state is not a valid state for an event source. 지정한 Object Storage 파일을 가져올 수 없는 상태인 경우
409 Conflict The request could not be processed because of a conflict in the current status of the resource. 같은 이름의 Imported Backup이 이미 존재하는 경우
409 ResourceInUse The specified resource is in use. 지정한 Object Storage 파일이 다른 가져오기 작업에 사용 중인 경우
참고

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

응답 예시

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

{
  "id": "b013988b-045f-4a0b-8bab-6a10639f4dad",
  "done": false,
  "metadata": {
    "operationType": "CREATE",
    "resourceType": "imported-backups",
    "startDateTime": "2026-10-13T12:00:00.006172325Z",
    "endDateTime": null
  },
  "results": null
}