createImportedBackup

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

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

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

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

Object Storage의 백업 파일을 가져와 Imported Backup을 생성합니다. 비동기(LRO)로 처리됩니다. 최대 크기는 16 TiB입니다.

요청

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

메서드	URI
POST	/imported-backups

요청 헤더

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

요청 바디

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

필드	타입	필수 여부	설명
`name`	String	Required	Imported Backup 이름 (하이픈 시작/끝 불가, 엔진 내 유일) 패턴: `^[a-z0-9-]+$` 길이: 3 ~ 30 <예시> import
`bucketName`	String	Required	소스 Object Storage 버킷 <예시> my-bucket
`objectPath`	String	Required	버킷 내 백업 파일 경로 패턴: `^[a-zA-Z0-9._/\-]+$` <예시> exports/backup.tar.gz
`zoneCode`	String	Optional	저장 존 (생략 시 첫 번째 가용 존) <예시> KR-2
`engineVersion`	String	Required	백업을 생성한 DB 엔진 버전 (필수 — 복원 대상 버전 결정에 사용. 엔진 종류는 경로의 engine으로 식별) <예시> 8.4.5

요청 예시

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

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": "import",
  "bucketName": "my-bucket",
  "objectPath": "exports/backup.tar.gz",
  "engineVersion": "8.4.5"
}'

응답

응답 형식을 설명합니다.

응답 헤더

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

필드	필수 여부	설명
`retry-after`	Optional	권장 폴링 간격 (초). done=false인 동안 이 간격으로 폴링 (202 응답)

응답 바디

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

필드	타입	필수 여부	설명
`id`	String (uuid)	-	Operation 식별자 <예시> 550e8400-e29b-41d4-a716-446655440000
`done`	Boolean	-	완료 여부 `true` \| `false` `true`: 완료 `false`: 진행 중 <예시> false
`metadata`	Object	-	작업 유형·대상 리소스·시각 등 Operation 부가 정보
`metadata.operationType`	String	-	작업 유형 `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 생성 `UPDATE`: 변경 `DELETE`: 삭제 <예시> CREATE
`metadata.resourceType`	String	-	대상 리소스 (REST 경로의 리소스 세그먼트와 일치 — 컬렉션은 복수형, 싱글턴은 경로 그대로) <예시> users
`metadata.startDateTime`	String (date-time)	-	작업 시작 시각 (RFC3339 UTC) <예시> 2026-07-21T10:00:00Z
`metadata.endDateTime`	String (date-time) \| null	-	완료 시각 (진행 중이면 null)
`metadata.progress`	Integer (int32) \| null	-	진행률 (%) — 제공 가능한 작업에 한함 범위: 0 ~ 100
`results`	Map<Object> \| null	-	성공 결과. 요청 인덱스를 키로 하는 Map이며 단건 작업은 "0" 키 하나를 사용
`results.<키>`	Object	-	해당 index의 생성·변경된 리소스 표현
`error`	Object	-	실패 사유 (단건 작업)
`error.errorCode`	String	-	에러 코드
`error.message`	String	-	에러 메시지 (기본 영어, 다국어 지원 가능)
`error.detail`	String	-	에러 상세 정보 (기본 영어, 다국어 지원 가능)
`error.fieldErrors`	List<FieldError>	-	입력값 에러가 발생한 경우 각 필드별 에러 상세 정보 목록
`failures`	Map<Error> \| null	-	일괄 작업의 index별 실패 사유

FieldError

필드 에러 정보

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

Error

에러 정보

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

응답 상태 코드

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

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

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 파일이 다른 가져오기 작업에 사용 중인 경우

응답 예시

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "done": false,
  "metadata": {
    "operationType": "CREATE",
    "resourceType": "users",
    "startDateTime": "2026-07-21T10:00:00Z",
    "endDateTime": "string(date-time)",
    "progress": "integer"
  },
  "results": {
    "key": {}
  },
  "error": {
    "errorCode": "string",
    "message": "string",
    "detail": "string",
    "fieldErrors": [
      {
        "message": "string",
        "field": "string"
      }
    ]
  },
  "failures": {
    "key": {
      "errorCode": "string",
      "message": "string",
      "detail": "string",
      "fieldErrors": [
        {
          "message": "string",
          "field": "string"
        }
      ]
    }
  }
}