Available in VPC
Send Cloud DB for Cache 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.
Cloud DB for Cache CLI offers two versions based on the supported DBMS range.
- exportBackupToObjectStorage CLI: Available for Valkey and Redis DBMS
- exportBackupToObjectStorage CLI: Available for Redis DBMS
exportBackupToObjectStorage CLI
This section describes the command syntax, options, commands, and output examples for the exportBackupToObjectStorage CLI.
Syntax
The exportBackupToObjectStorage syntax is as follows:
./ncloud vcache exportBackupToObjectStorage \
--cloudCacheInstanceNo <instance-no> \
--fileName <backup-file-name> \
--bucketName <bucket-name> \
--backupTypeMode <SYSTEM|MANUAL> \
[--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 |
|---|---|---|---|
--cloudCacheInstanceNo |
String | Required | Cloud DB for Cache instance number |
--fileName |
String | Required | Backup file name |
--bucketName |
String | Required | Name of the Object Storage bucket to which the backup files will be sent
|
--backupTypeMode |
String | Required | Cloud DB for Cache backup type
|
Common options
For information about the options common to all vcache subcommands, see Cloud DB for Cache (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 vcache exportBackupToObjectStorage \
--cloudCacheInstanceNo 34567890 \
--fileName 202606101507 \
--bucketName my-test-bucket \
--backupTypeMode MANUAL \
--regionCode KR \
--output json
Output
The output example is as follows:
{
"exportBackupToObjectStorageResponse": {
"requestId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"returnCode": "0",
"returnMessage": "success"
}
}
exportBackupToObjectStorage CLI (Redis)
This section describes the command syntax, options, commands, and output examples for the exportBackupToObjectStorage CLI.
Syntax
The exportBackupToObjectStorage syntax is as follows:
./ncloud vredis exportBackupToObjectStorage \
--cloudRedisInstanceNo <instance-no> \
--fileName <backup-file-name> \
--bucketName <bucket-name> \
--backupTypeMode <SYSTEM|MANUAL> \
[--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 |
|---|---|---|---|
--cloudRedisInstanceNo |
String | Required | Cloud DB for Cache instance number |
--fileName |
String | Required | Backup file name |
--bucketName |
String | Required | Name of the Object Storage bucket to which the backup files will be sent
|
--backupTypeMode |
String | Required | Cloud DB for Cache backup type
|
Common options
For information about the options common to all vredis subcommands, see Cloud DB for Cache (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 vredis exportBackupToObjectStorage \
--cloudRedisInstanceNo 34567890 \
--fileName 20260626 \
--bucketName my-test-bucket \
--backupTypeMode SYSTEM \
--regionCode KR \
--output json
Output
The output example is as follows:
{
"exportBackupToObjectStorageResponse": {
"requestId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"returnCode": "0",
"returnMessage": "success"
}
}