Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

exportBackupToObjectStorage

Prev Next

VPC環境で利用できます。

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

構文

exportBackupToObjectStorage構文は次の通りです。

./ncloud vmongodb exportBackupToObjectStorage \
    --cloudMongoDbInstanceNo <instance-no> \
    --objectName <object-name> \
    --bucketName <bucket-name> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

exportBackupToObjectStorageの実行時に指定できるオプションについて説明します。

必須オプション

exportBackupToObjectStorageの必須オプションです。

オプション タイプ 必須の有無 説明
--cloudMongoDbInstanceNo String Required Cloud DB for MongoDBインスタンス番号
--objectName String Required Object Storageに転送するバックアップファイルの名前
--bucketName String Required バックアップファイルが転送される Object Storageバケットの名前

共通オプション

vmongodbコマンドで共通して使用するオプションについては、Cloud DB for MongoDB (VPC)のオプションを参照してください。

バックアップファイルの転送リクエストが成功すると、指定した Object Storageのバケットにバックアップファイルが転送されます。

コマンド

コマンドの例は次の通りです。

./ncloud vmongodb exportBackupToObjectStorage \
    --cloudMongoDbInstanceNo 34567890 \
    --objectName a1b2c3d4e5f6a7b8c9d0e1f2 \
    --bucketName my-test-bucket \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "exportBackupToObjectStorageResponse": {
    "requestId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "returnCode": "0",
    "returnMessage": "success"
  }
}