exportBackupToObjectStorage

Prev Next

VPC環境で利用できます。

Cloud DB for MSSQLインスタンスのバックアップファイルを Object Storageに転送します。

参考

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

リクエスト

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

メソッド URI
GET, POST /exportBackupToObjectStorage

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional バックアップファイルを Object Storageに転送する Cloud DB for MSSQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudMssqlInstanceNo String Required Cloud DB for MSSQLインスタンス番号
cloudMssqlServerInstanceNo String Required Cloud DB for MSSQLサーバインスタンス番号
bucketName String Required バックアップファイルが転送される Object Storageバケット名
folderPath String Optional Object Storageバケットのフォルダパス
cloudMssqlExportObjectList.N.fullObjectName List<String> Required Object Strogeに転送するファイルのパスリスト
  • バックアップファイル転送時、getCloudMssqlBackupDetailListを通じて確認
  • ログのバックアップファイル転送時、getLogBackupFileListを通じて確認
  • <例> cloudMssqlExportObjectList.1.fullObjectName=Z:\test1&cloudMssqlExportObjectList.2.fullObjectName=Z:\test2
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/exportBackupToObjectStorage
?regionCode=KR
&cloudMssqlInstanceNo=2517****
&cloudMssqlServerInstanceNo=2517****
&bucketName=bucket
&cloudMssqlExportObjectList.1.fullObjectName=Z%3A%5Ccmssql_backup%5Cuser_idx_276****%5Ccmssql_10-0-252-15_m-2517****-001%5Cmsdb_20240702_*****.full
&responseFormatType=json'
--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のレスポンスステータスコードをご参照ください。

レスポンス例

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

  • responseFormetType=jsonの場合

    {
    "exportBackupToObjectStorageResponse": {
        "requestId": "2c5fab4b-****-****-****-8e1f96fb024a",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

  • responseFormetType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
<exportBackupToObjectStorageResponse>
    <requestId>2c5fab4b-****-****-****-8e1f96fb024a</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</exportBackupToObjectStorageResponse>