exportBackupToObjectStorage

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

Cloud DB for MongoDB 인스턴스의 백업 파일을 Object Storage로 전송합니다.

참고

백업 파일을 Object Storage로 전송하려면 백업 파일을 저장하고, 검색하기 위한 Object Storage 버킷이 생성되어 있어야 합니다. 자세한 내용은 Object Storage 가이드를 참조해 주십시오.

요청

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

메서드	URI
GET \| POST	/vmongodb/v2/exportBackupToObjectStorage

참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`regionCode`	String	Optional	백업 파일을 Object Storage로 전송할 Cloud DB for MongoDB 인스턴스의 리전 코드 getRegionList 참조 `getRegionList` 조회 결과의 첫 번째 리전(기본값)
`objectName`	String	Required	Object Storage로 전송할 백업 파일 이름 getCloudMongoDbBackupDetailList 참조
`bucketName`	String	Required	Object Storage 버킷 이름 getCloudMongoDbBucketList 참조
`cloudMongoDbInstanceNo`	String	Required	Cloud DB for MongoDB 서버 인스턴스 번호 getCloudMongoDbInstanceList 참조
`responseFormatType`	String	Optional	응답 결과의 형식 `xml` (기본값) \| `json`

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/vmongodb/v2/exportBackupToObjectStorage
?regionCode=KR
&objectName=668583966f***
&bucketName=bucket
&cloudMongoDbInstanceNo=2512****
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

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

responseFormatType=json 일 때

{
    "exportBackupToObjectStorageResponse": {
        "requestId": "f75d4a43-****-****-****-ec3b56cd3ea4",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

responseFormatType=xml (기본값) 일 때

<?xml version="1.0" encoding="UTF-8"?>
<exportBackupToObjectStorageResponse>
    <requestId>f75d4a43-****-****-****-ec3b56cd3ea4</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</exportBackupToObjectStorageResponse>