exportBackupToObjectStorage

Available in VPC

Send Cloud DB for MSSQL 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 vmssql exportBackupToObjectStorage \
    --cloudMssqlInstanceNo <instance-no> \
    --cloudMssqlServerInstanceNo <server-instance-no> \
    --cloudMssqlExportObjectList <export-object-config> \
    --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
`--cloudMssqlInstanceNo`	String	Required	Cloud DB for MSSQL instance number See getCloudMssqlInstanceList.
`--cloudMssqlServerInstanceNo`	String	Required	Cloud DB for MSSQL server instance number See getCloudMssqlInstanceList.
`--cloudMssqlExportObjectList`	List	Required	List of backup files to transfer to Object Storage For each entry, enter {field=‘value’} pairs within quotation marks. `fullObjectName` (required): Full path of the backup file to be transferred. See `fullFileName` of getCloudMssqlBackupDetailList.
`--bucketName`	String	Required	Name of the Object Storage bucket the backup file will be sent to See getCloudMssqlBucketList.

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 vmssql subcommands, see Cloud DB for MSSQL (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 vmssql exportBackupToObjectStorage \
    --cloudMssqlInstanceNo 25280088 \
    --cloudMssqlServerInstanceNo 25280089 \
    --cloudMssqlExportObjectList 'fullObjectName="Z:\\cmssql_backup\\user_idx_0000000\\cmssql_10-0-0-6_m-25280088-001\\msdb_20260609_202338.full"' \
    --bucketName my-test-bucket \
    --folderPath mssql-backup/ \
    --regionCode KR \
    --output json

Output

The output example is as follows:

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

Documentation Index