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 Cacheのバックアップファイルを Object Storageに転送します。バックアップファイルを Object Storageに転送する前に、バックアップファイルの保存・検索用の Object Storageバケットが作成されている必要があります。詳細は、Object Storageご利用ガイドをご参照ください。

参考

Cloud DB for Cache CLIは、対応する DBMSの範囲に応じて2つのバージョンを提供しています。

  • exportBackupToObjectStorage CLI: Valkey、Redis DBMSを利用可能
  • exportBackupToObjectStorage CLI: Redis DBMSを利用可能

exportBackupToObjectStorage CLI

exportBackupToObjectStorage CLIのコマンド構文とオプション、コマンドと出力の例について説明します。

構文

exportBackupToObjectStorage構文は次の通りです。

./ncloud vcache exportBackupToObjectStorage \
    --cloudCacheInstanceNo <instance-no> \
    --fileName <backup-file-name> \
    --bucketName <bucket-name> \
    --backupTypeMode <SYSTEM|MANUAL> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

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

必須オプション

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

オプション タイプ 必須の有無 説明
--cloudCacheInstanceNo String Required Cloud DB for Cacheインスタンス番号
--fileName String Required バックアップファイル名
--bucketName String Required バックアップファイルが転送される Object Storageバケットの名前
--backupTypeMode String Required Cloud DB for Cacheバックアップタイプ
  • SYSTEM | MANUAL
      • SYSTEM: システムバックアップ
      • MANUAL: 手動バックアップ

共通オプション

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

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

コマンド

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

./ncloud vcache exportBackupToObjectStorage \
    --cloudCacheInstanceNo 34567890 \
    --fileName 202606101507 \
    --bucketName my-test-bucket \
    --backupTypeMode MANUAL \
    --regionCode KR \
    --output json

出力

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

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

exportBackupToObjectStorage CLI (Redis)

exportBackupToObjectStorage CLIのコマンド構文とオプション、コマンドと出力の例について説明します。

構文

exportBackupToObjectStorage構文は次の通りです。

./ncloud vredis exportBackupToObjectStorage \
    --cloudRedisInstanceNo <instance-no> \
    --fileName <backup-file-name> \
    --bucketName <bucket-name> \
    --backupTypeMode <SYSTEM|MANUAL> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

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

必須オプション

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

オプション タイプ 必須の有無 説明
--cloudRedisInstanceNo String Required Cloud DB for Cacheインスタンス番号
--fileName String Required バックアップファイル名
--bucketName String Required バックアップファイルが転送される Object Storageバケットの名前
--backupTypeMode String Required Cloud DB for Cacheバックアップタイプ
  • SYSTEM | MANUAL
      • SYSTEM: システムバックアップ
      • MANUAL: 手動バックアップ

共通オプション

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

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

コマンド

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

./ncloud vredis exportBackupToObjectStorage \
    --cloudRedisInstanceNo 34567890 \
    --fileName 20260626 \
    --bucketName my-test-bucket \
    --backupTypeMode SYSTEM \
    --regionCode KR \
    --output json

出力

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

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