exportBackupToObjectStorage

Available in VPC

Send Cloud DB for MongoDB instance backup files to Object Storage. To send backup files to Object Storage, Object Storage buckets for storing and searching backup files must be created in advance. For more information, see Object Storage user guide.

Syntax

The exportBackupToObjectStorage syntax is as follows:

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

Options

This section describes the options available when running exportBackupToObjectStorage.

Required options

The following options are required for exportBackupToObjectStorage.

Options	Type	Required	Description
`--cloudMongoDbInstanceNo`	String	Required	Instance number of Cloud DB for MongoDB See getCloudMongoDbInstanceList.
`--objectName`	String	Required	Name of the backup file to send to Object Storage See getCloudMongoDbBackupDetailList.
`--bucketName`	String	Required	Name of the Object Storage bucket to which the backup files will be sent See Object Storage.

Common options

For information about the options common to all vmongodb subcommands, see Cloud DB for MongoDB (VPC) options.

Examples

If the backup file transfer request is successful, the backup file will be transferred to the specified Object Storage bucket.

Command

The command example is as follows:

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

Output

The output example is as follows:

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

Documentation Index