exportBackupToObjectStorage

VPC環境で利用できます。

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

参考

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

リクエスト

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

メソッド	URI
GET \| POST	/vmongodb/v2/exportBackupToObjectStorage

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	バックアップファイルを Object Storageに転送する Cloud DB for MongoDBインスタンスのリージョンコード getRegionListを参照 `getRegionList`照会結果の最初のリージョン(デフォルト)
`objectName`	String	Required	Object Storageに転送するバックアップファイルの名前 getCloudMongoDbBackupDetailListを参照
`bucketName`	String	Required	Object Storageのバケット名 getCloudMongoDbBucketListを参照
`cloudMongoDbInstanceNo`	String	Required	Cloud DB for MongoDBサーバインスタンス番号 getCloudMongoDbInstanceListを参照
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmongodb/v2/exportBackupToObjectStorage
?regionCode=KR
&objectName=668583966f***
&bucketName=bucket
&cloudMongoDbInstanceNo=2512****
&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}'

レスポンス

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

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

Cloud DB for MongoDB (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud DB for MongoDB (VPC)のレスポンスステータスコードをご参照ください。

レスポンス例

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

responseFormatType=jsonの場合

{
    "exportBackupToObjectStorageResponse": {
        "requestId": "f75d4a43-****-****-****-ec3b56cd3ea4",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

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