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

Available in VPC

Send Cloud DB for MySQL 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 vmysql exportBackupToObjectStorage \
    --cloudMysqlInstanceNo <instance-no> \
    --fileName <backup-file-name> \
    --bucketName <bucket-name> \
    [--folderPath <folder-path>] \
    [--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
--cloudMysqlInstanceNo String Required Cloud DB for MySQL instance number
--fileName String Required Backup fie name
--bucketName String Required Name of the Object Storage bucket to which the backup files will be sent

Optional options

These are the optional options for exportBackupToObjectStorage. Options that are not specified will use their default values.

Options Type Required Description
--folderPath String Optional Folder path where backup files will be sent

Common options

For information about the options common to all vmysql subcommands, see Cloud DB for MySQL (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 vmysql exportBackupToObjectStorage \
    --cloudMysqlInstanceNo 12345678 \
    --fileName 20260604 \
    --bucketName my-test-bucket \
    --folderPath cloud-db-for-mysql/ \
    --regionCode KR \
    --output json

Output

The output example is as follows:

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