exportBackupToObjectStorage

Prev Next

VPC環境で利用できます。

Cloud DB for MySQLインスタンスのバックアップファイルを Object Storageに転送します。
バックアップファイルを Object Storageに転送する前に、バックアップファイルの保存・検索用の Object Storageバケットが作成されている必要があります。詳細は、Object Storageガイドをご参照ください。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET, POST /exportBackupToObjectStorage

リクエストヘッダ

Cloud DB for MySQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MySQL (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • バックアップファイルを Object Storageに転送する Cloud DB for MySQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
fileName String Required バックアップファイル名
bucketName String Required バックアップファイルが転送される Object Storageバケット名
folderPath String Optional バックアップファイルが転送されるフォルダパス
cloudMysqlInstanceNo String Required Cloud DB for MySQLインスタンス番号
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/exportBackupToObjectStorage
?regionCode=KR
&fileName=20210528
&bucketName=mysql-backup
&folderPath=cloud-db-for-mysql/
&cloudMysqlInstanceNo=****890'
--header 'x-ncp-apigw-timestamp: {Timestamp}' 
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

  • responseFormatType=jsonの場合
{
    "exportBackupToObjectStorageResponse": {
        "requestId": "f601a8b4-****-****-****-1451ecb1fd6b",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<exportBackupToObjectStorageResponse>
    <requestId>f601a8b4-****-****-****-1451ecb1fd6b</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</exportBackupToObjectStorageResponse>