Overview
The Cloud DB APIs can be used in common across Cloud DB for MSSQL, Cloud DB for MySQL, and Cloud DB for Cache.
Common settings
API URL
https://ncloud.apigw.ntruss.com/clouddb/v2
Request headers
| Header name | Description |
|---|---|
x-ncp-apigw-timestamp |
This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. Request is considered invalid if the timestamp differs from the current time by more than 5 minutes. |
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 above example with the secret key that maps with the access key Use the HMAC-SHA256 encryption algorithm. |
Check API key
- You can check the access key and secret key at in the My Page > Manage account > Manage authentication key page.
Operations
Cloud DB
| API name | Available DB |
|---|---|
| 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 |
| getDbServerLogList | MySQL only |
| exportDbServerLogToObjectStorage | MySQL only |
DMS
DMS stands for Data Migration Service, and is a service where you can recover a database you were running on-premise to Cloud DB, or transfer backup files automatically backed up in Cloud DB to Object Storage.
The service is an API using API Gateway and is available after you create a bucket in Object Storage. You can transfer even a large database to a cloud database with only a few minutes of service downtime.
| API name | Description |
|---|---|
| setObjectStorageInfo | Set Object Storage information. (It must be configured for uploading and downloading of files, and the recovery can be done from NAVER Cloud Platform, Amazon S3 compatible API Object Storage, or Archive Storage.) Currently, DMS only supports MSSQL. |
| downloadDmsFile | Download the backup file from Amazon S3 compatible storage to the internal recovery storage using the information stored using setObjectStorageInfo. The file must be moved to the internal recovery storage to restore the database using the backup file. In the example output, save the requestNo and use the getDmsOperation API to check the progress. |
| uploadDmsFile | The running database is automatically backed up and the backup file is uploaded to Object Storage (the internal recovery-only directory referenced by downloadDmsFile and the backup directory referenced by uploadDmsFile are different physical paths due to reliability issues with the backup file). |
| getObjectStorageBackupList | Get the list of backup files uploaded from Object Storage to internal backup storage. Database restores can be performed on files moved to internal backup storage. Internal backup storage files are completely deleted after 15 days and cannot be deleted by users (if you execute the download command from Object Storage to internal backup storage with the same file name, it will be changed to a new file). Print the list to check if the capacity of on-premises, Object Storage, and internal backup storage is the same. |
| getBackupList | Get automatic backup list. |
| restoreDmsDatabase | Restore database using files moved to internal backup storage. Be careful with isRecovery option because it does not provide a separate restore database [userdb] with recovery API. You can get the requestNo of the response using the getDmsOperation API to check the progress. |
| restoreDmsTransactionLog | Restore DMS transaction logs. |
| getDmsOperation | Get DMS status (check codeName in the example response). |