CloudDB Overview
  • PDF

CloudDB Overview

  • PDF


Cloud DB API is available for CloudDB for MSSQL, CloudDB for MySQL, and CloudDB for Redis.

Common information


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-iam-access-key API key issued by NAVER Cloud Platform or access key issued by IAM
x-ncp-apigw-signature-v2 Signature used to encrypt the body of the example with the “secret key” that maps with the “access key.”
The HMAC encryption algorithm is HMAC SHA256.

Get API key

  • Go to My Page > Manage Account > Manage Auth Key to get an access key and secret key.


Cloud DB

Operation Available DBs
createCloudDBInstance MSSQL , MySQL , Redis
deleteCloudDBServerInstance MSSQL , MySQL , Redis
getCloudDBInstanceList MSSQL , MySQL , Redis
getCloudDBConfigGroupList MSSQL only
getCloudDBImageProductList MSSQL , MySQL , Redis
getCloudDBProductList MSSQL , MySQL , Redis
rebootCloudDBServerInstance MSSQL , MySQL
flushCloudDBInstance Redis only
getCloudDBBackupDetailList MySQL only
exportBackupToObjectStorage MySQL only


DMS stands for data migration service, which helps you restore on-premise databases to Cloud DB or transfer backup files that have been automatically backed up from Cloud DB to Object Storage.

You can use the service with the following operations via API Gateway, after creating a bucket in Object Storage. With this service, even large databases can be transferred to your cloud DB, with just a few minutes of service interruptions.

Operation Description
setObjectStorageInfo Sets Object Storage information (which must be set for file uploads and downloads, and can be restored from Ncloud or Amazon S3 compatible API Object Storage or Archive Storage).
Currently, DMS is supported only in MSSQL. ↩
downloadDmsFile Downloads backup files from the Amazon S3 compatible storage to the internal backup storage, using the information that is stored with setObjectStorageInfo.
The backup files can be used to restore your database only after they are transferred to the internal backup storage.
Use getDmsOperation to get the download progress, with the requestNo you can get from the response.
uploadDmsFile Uploads backups, which are automatically performed by a running database, to Object Storage. (The directory for internet recovery referenced by downloadDmsFile is physically different from the backup directory referenced by uploadDmsFile, for reliability reasons.)
getObjectStorageBackupList Gets a list of backup files transferred from Object Storage to the internal backup storage.
Only the backup files transferred to the internal backup storage can be used to restore databases.
The files in the internal backup storage will be completely deleted 15 days after being transferred, and cannot be deleted manually by users. (If you download a file with the same name from Object Storage to the internal backup storage, the existing file is replaced with the new one.)
Get a list to check if the on-premise databases, Object Storage and the internal backup storage are the same in size.↩
getBackupList Gets a list of automatic backups.
restoreDmsDatabase Restores databases with the backup files in the internal backup storage.
Make sure isRecovery is correctly set, as there is no restore database [userdb] with recovery API.
Use getDmsOperation to get the restoring progress, with the requestNo you can get from the response.
restoreDmsTransactionLog Restores DMS transaction logs.
getDmsOperation Gets DMS status. See the codeName in the response.

Was this article helpful?