exportBackupToObjectStorage

Prev Next

Overview

Export the backup file to Object Storage.

Request

Request header

Header Description
x-ncp-apigw-timestamp It is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key API key issued by API Gateway (not used in the API v2)
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key Access Key ID issued from the NAVER CLOUD PLATFORM portal.
x-ncp-iam-access-key:{Sub Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with your Access Key ID and Secret Key.
x-ncp-apigw-signature-v2:{API Gateway Signature}
Content-Type Set the request body content type to application/json.
Content-Type: application/json

Request body

Field names in the request body are case sensitive.

Parameter Required Type Limitations Description
regionNo N String Region number
dbKindCode Y String MYSQL DB type code
fileName Y String Can be acquired through getCloudDBBackupDetailList
bucketName Y String
cloudDBInstanceNo Y String Value acquired through getCloudDBInstanceList
responseFormatType N String xml, json Sets the results format of the response

  • regionNo

    • It can be acquired through getRegionList, which is a server API.

  • dbKindCode

    • Selects the type of Cloud DB to search. Only MySQL can be entered.

  • fileName

  • bucketName

    • Enter the name of the bucket created in the console.

  • cloudDBInstanceNo

    • It is the instance number of the MySQL server that has been created. It can be acquired through getCloudDBInstanceList.

  • responseFormatType

    • Sets the response format of the API execution results. You can select between XML and JSON.

Response

Field Type Description Note
returnCode Integer
returnMessage String

Examples

Request example

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

Request sample

  • Get a list of MySQL instances
{
  "regionNo": "1",
  "dbKindCode": "MYSQL",
  "fileName": "20220210",
  "bucketName": "mysql-b",
  "cloudDBInstanceNo": "2090164",
  "responseFormatType": "json"
}

Response example

 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"
  }
}

Error codes

If a Cloud DB API request is invalid or an error occurs while processing the request, the API returns an HTTP status code representing success or failure with a detailed message in JSON.

There are two types of error codes: “common error code” of the Cloud DB API and “API Gateway error code.”

Error code Response message Description
200 Ok
500 Server Error