概要
CloudDB APIは、CloudDB for MSSQL、CloudDB for MySQL、CloudDB for Cacheで共通して使用できます。
共通の設定
API URL
https://ncloud.apigw.ntruss.com/clouddb/v2
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
x-ncp-apigw-timestamp |
1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒で表したもの API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす |
x-ncp-iam-access-key |
NAVERクラウドプラットフォームで発行された API Keyまたは IAMで発行された Access Key |
x-ncp-apigw-signature-v2 |
上記例の Bodyを Access Keyとマッピングする Secret Keyで暗号化した署名 HMAC暗号化アルゴリズムは、HmacSHA256を使用 |
API KEYの確認
- マイページ > アカウント管理 > 認証キー管理画面で access keyと secret keyを確認できます。
オペレーション
Cloud DB
| API名 | 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は Data Migration Serviceの略語で、オンプレミスから運用していたデータベースを CloudDBに復旧したり、CloudDBで自動バックアップされたバックアップファイルをオブジェクトストレージに移すことができるサービスです。
このサービスは API Gatewayを利用した APIであり、オブジェクトストレージにバケットを作成すると使用できます。大容量データベースも数分のサービス中止時間だけでクラウドデータベースに移すことができます。
| API名 | 説明 |
|---|---|
| setObjectStorageInfo | オブジェクトストレージ情報を設定(ファイルアップロード・ダウンロードのために設定する必要があり、NAVERクラウドプラットフォームや Amazon S3互換 APIオブジェクトストレージ、アーカイブストレージから復旧可能) 現在、DMSは MSSQLのみサポート |
| downloadDmsFile | setObjectStorageInfoで保存した情報を利用し、Amazon S3互換ストレージから内部復旧用ストレージにバックアップファイルをダウンロード 内部復旧用ストレージにファイルを移すとそのバックアップファイルを利用してデータベースを復旧可能 例の出力で requestNoを保存し、getDmsOperation APIを利用して進行状態を照会可能 |
| uploadDmsFile | 運用中だったのデータベースは、自動でバックアップを行ってそのバックアップファイルをオブジェクトストレージにアップロード(downloadDmsFileが参照する内部復旧専用ディレクトリと、uploadDmsFileが参照するバックアップディレクトリは、バックアップファイルの安定性の問題から、異なる物理的なパス) |
| getObjectStorageBackupList | オブジェクトストレージで内部バックアップストレージにアップロードしたバックアップファイルリストを照会 データベースリストアは内部バックアップストレージに移されたファイルを対象に行うことができる 内部バックアップストレージファイルは15日後に完全に削除され、ユーザーは削除できない(同じファイル名でオブジェクトストレージから内部バックアップストレージにダウンロードコマンドを実行すると、新しいファイルに変更される) リストを出力してオンプレミス、オブジェクトストレージ、内部バックアップストレージの容量が同じなのかを確認↩ |
| getBackupList | 自動バックアップリストを照会 |
| restoreDmsDatabase | 内部バックアップストレージに移したファイルを利用してデータベースを復旧 restore database [userdb] with recovery APIを別途提供しないので、isRecoveryオプションに注意 レスポンスの requestNoを getDmsOperation APIで進行状況を照会 |
| restoreDmsTransactionLog | DMSトランザクションログを復旧 |
| getDmsOperation | DMS状態を照会 (例のレスポンスから codeNameを確認) |