exportBackupToObjectStorage

Prev Next

개요

백업 파일을 Object Storage로 내보냅니다.

요청

요청 헤더

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGW에서 발급받은 키 값, v2를 사용할 경우 api-key는 사용하지 않음
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Sub Account Access Key}
x-ncp-apigw-signature-v2 Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v2:{API Gateway Signature}
Content-Type Request body content type을 application/json으로 지정
Content-Type: application/json

요청 바디

API 요청 시 필드명의 대소문자 구분이 필요합니다.

파라미터명 필수 여부 타입 제약 사항 설명
regionNo N String 리전 번호
dbKindCode Y String MYSQL DB 유형 코드
fileName Y String getCloudDBBackupDetailList 를 통해 취득 가능
bucketName Y String
cloudDBInstanceNo Y String getCloudDBInstanceList 를 통해 취득하는 값
responseFormatType N String xml, json response의 결과 format 설정

  • regionNo

    • Server API인 getRegionList 를 통해 얻을 수 있습니다.

  • dbKindCode

    • 조회할 CloudDB의 종류를 선택합니다. MySQL만 입력 가능합니다.

  • fileName

  • bucketName

    • 콘솔에 생성된 버킷 이름을 입력합니다.

  • cloudDBInstanceNo

    • 생성되어있는 MySQL서버의 Instance 번호입니다. getCloudDBInstanceList 를 통해 얻을 수 있습니다.

  • responseFormatType

    • API 실행 결과를 응답 받을 format을 정합니다. xml과 json 중에서 선택 가능합니다.

응답

필드명 타입 설명 비고
returnCode Integer
returnMessage String

예시

요청 예시

curl -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/exportBackupToObjectStorage?regionNo=1&dbKindCode=MYSQL&fileName=20220210&bucketName=mysql-b&cloudDBInstanceNo=2090164&cloudDBServerInstanceNo=2090166&responseFormatType=json" 
-H "accept: application/json" 
-H "Content-Type: application/x-www-form-urlencoded" 
-H "x-ncp-iam-access-key: UhO0EH9R8Gts7PoPPz27" 
-H "x-ncp-apigw-timestamp: 1644486011957" 
-H "x-ncp-apigw-signature-v2: 2fvwJH5+4fpM3RMlR0qMEaDzucSkjnzmDizosMXkBSI=" 
-H "cache-control: no-cache" 
-H "pragma: no-cache"

https://ncloud.apigw.ntruss.com/clouddb/v2/exportBackupToObjectStorage?regionNo=1&dbKindCode=MYSQL&fileName=20220210&bucketName=mysql-b&cloudDBInstanceNo=2090164&cloudDBServerInstanceNo=2090166&responseFormatType=json

요청 샘플

  • MySQL로 생성된 instance list 조회
{
  "regionNo": "1",
  "dbKindCode": "MYSQL",
  "fileName": "20220210",
  "bucketName": "mysql-b",
  "cloudDBInstanceNo": "2090164",
  "responseFormatType": "json"
}

응답 예시

 connection: keep-alive 
 content-type: application/json;charset=UTF-8 
 date: Thu, 10 Feb 2022 09:40:12 GMT 
 server: nginx 
 transfer-encoding: chunked 
 x-ncp-apigw-response-origin: ENDPOINT 
 x-ncp-trace-id: 34opkc4q34o9g38d1mcdh32dr1 

{
  "exportBackupToObjectStorageResponse": {
    "requestId": "b9e7d957-9981-4bd0-b134-ae89d4a6c1b0",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

오류 코드

Cloud DB API 요청이 잘못되었거나, 처리 도중 오류가 발생하면 HTTP 상태코드로 성공/실패를 반환하고 JSON 형식으로 상세 메시지를 반환합니다.

오류 코드는 Cloud DB API의 '공통 오류 코드'와 'API Gateway 오류 코드' 두 가지입니다.

오류 코드 응답 메시지 설명
200 Ok
500 Server Error