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.

createCloudCacheInstance

Prev Next

VPC環境で利用できます。

Cloud DB for Cacheインスタンスを作成します。

参考

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

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

createCloudCacheInstance CLI

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

構文

createCloudCacheInstance構文は次の通りです。

./ncloud vcache createCloudCacheInstance \
    --vpcNo <vpc-no> \
    --subnetNo <subnet-no> \
    --cloudCacheServiceName <service-name> \
    --cloudCacheServerNamePrefix <server-name-prefix> \
    --configGroupNo <config-group-no> \
    --cloudCacheModeCode <SIMPLE|CLUSTER> \
    [--cloudCacheImageProductCode <image-product-code>] \
    [--cloudCacheProductCode <product-code>] \
    [--engineVersionCode <engine-version-code>] \
    [--shardCount <shard-count>] \
    [--shardCopyCount <shard-copy-count>] \
    [--isHa <true|false>] \
    [--isBackup <true|false>] \
    [--isAutomaticBackup <true|false>] \
    [--backupTime <hh:mm>] \
    [--backupFileRetentionPeriod <retention-days>] \
    [--cloudCachePort <port>] \
    [--cloudCacheDbmsCode <Redis|Valkey>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

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

必須オプション

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

オプション タイプ 必須の有無 説明
--vpcNo String Required Cloud DB for Cacheインスタンスを作成する VPC番号
--subnetNo String Required Cloud DB for Cacheインスタンスの Subnet番号
  • Private Subnetでのみ作成可能
  • Cloud DB for Cacheインスタンス作成後に Subnetの移転はできない
  • getCloudCacheTargetSubnetListを参照
--cloudCacheServiceName String Required Cloud DB for Cacheサービスの名前
  • 英数字、ハングル、記号の-を組み合わせて3~15以内で入力
  • DBサービス名は重複して使用不可
--cloudCacheServerNamePrefix String Required Cloud DB for Cacheサーバ名の接頭辞
  • 英字の小文字、数字、記号の-を組み合わせて3~15文字以内で入力
  • 先頭文字は英字、末尾文字は英字または数字のみ使用可能
  • 接頭辞の末尾に3桁の数字が自動で作成される
  • DBサーバ名は重複して使用不可
--configGroupNo String Required Config Group番号
  • DB Server設定を効率的に管理するための Config Groupを提供し、1つのクラスタ群はすべて同じ configを使用
  • Config Groupがない場合は新規作成が必要で、作成後はオンラインで変更可能
  • DB Serverのタイプ(Cluster/Simple)と Cacheエンジンのバージョン情報と一致する Config Group番号を入力
    • 例: DB Serverのタイプが Clusterで、エンジンのバージョンが7.0.15の場合、cloudCacheVersion7.0.15-clusterに対応するconfigGroupNoを入力
  • getCloudCacheConfigGroupListを参照
--cloudCacheModeCode String Required Cloud DB for Cacheモード
  • SIMPLE | CLUSTER
    • SIMPLE: Master、Standby-Master方式を使用する基本 Cache
    • CLUSTER: Master、Slave方式を使用し、データシャーディングによりトラフィックを分散できる Cache
  • CLUSTER設定を使用する場合、高可用性の有無(isHa)が入力されても無視する
--engineVersionCode String Conditional DBエンジンのバージョン
  • 入力しない場合、現在提供中の最新バージョンで作成
  • cloudCacheImageProductCodegenerationCodeG3の場合、必ず入力
  • getCloudCacheImageProductListを参照
--backupTime String Conditional バックアップ時点を設定 (HH:MM)
  • isBackup=trueisAutomaticBackup=falseの場合、必ず入力
  • 例: 01:15 (選択した時間 + 15分の間に Backupが開始)

任意オプション

createCloudCacheInstanceの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--cloudCacheImageProductCode String Optional Cloud DB for Cacheイメージ商品コード
--cloudCacheProductCode String Optional Cloud DB for Cache商品コード
  • Cloud DB for Cacheインスタンスのサーバスペックを決める
  • デフォルト: 最小スペック(メモリ、CPUの順)
  • getCloudCacheProductListを参照
--shardCount Integer Optional DBモードが Clusterの場合、Master Nodeの作成数
  • 3~10 (デフォルト: 3)
  • cloudCacheModeCodeCLUSTERの場合にのみ入力
  • cloudCacheModeCodeSIMPLEの場合、入力されても無視する
--shardCopyCount Integer Optional DBモードが Clusterの場合、Master Nodeのレプリカの Slave nodeの作成数
  • 0~4 (デフォルト: 0)
  • 高可用性(HA)のためには Slave nodeが必要で、レプリカを追加すると、すべての Master nodeに Slave nodeが1つずつ割り当てられる
  • 例: シャード3個、シャードごとのレプリカが1個の場合、Master Node 3台、Slave Node 3台
  • 0に設定すると、高可用性はサポートされない
  • cloudCacheModeCodeCLUSTERの場合にのみ入力
  • cloudCacheModeCodeSIMPLEの場合、入力されても無視する
--isHa Boolean Optional 高可用性の有無
  • true | false (デフォルト)
  • 高可用性を選択すると、Standby Masterサーバを利用した自動障害復旧をサポートし、追加料金が発生して自動的にバックアップが設定される
--isBackup Boolean Optional DB Serverのバックアップを設定するか
  • true | false (デフォルト)
  • isHa=trueの場合、trueに固定される
--isAutomaticBackup Boolean Optional バックアップ時点を自動設定するか
  • true (デフォルト) | false
  • trueの場合、backupTimeが入力されても無視し、自動で設定される
--backupFileRetentionPeriod Integer Optional バックアップファイルの保管期間(日)
  • 1~7 (デフォルト: 1)
  • バックアップは毎日行われ、バックアップファイルは別途バックアップストレージに保存
  • 料金は使用する容量だけ課金
--cloudCachePort Integer Optional Cloud DB for Cacheインスタンスアクセス用の TCPポート番号
  • 10000~20000 (デフォルト: 6379)
--cloudCacheDbmsCode String Optional Cloud DB for Cacheインスタンスの DBMSコード
  • Redis (デフォルト) | Valkey

共通オプション

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

Cloud DB for Cacheインスタンスの作成リクエストが成功すると、インスタンスの構成情報と作成状態が返されます。

コマンド

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

./ncloud vcache createCloudCacheInstance \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudCacheServiceName test-cache-01 \
    --cloudCacheServerNamePrefix testcache \
    --configGroupNo 11099 \
    --cloudCacheModeCode CLUSTER \
    --cloudCacheImageProductCode SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050 \
    --cloudCacheProductCode SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002 \
    --shardCount 3 \
    --shardCopyCount 1 \
    --isBackup true \
    --isAutomaticBackup true \
    --backupFileRetentionPeriod 1 \
    --cloudCachePort 13306 \
    --cloudCacheDbmsCode Valkey \
    --regionCode KR \
    --output json

出力

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

{
  "createCloudCacheInstanceResponse": {
    "totalRows": 1,
    "cloudCacheInstanceList": [
      {
        "cloudCacheInstanceNo": "34567890",
        "cloudCacheServiceName": "test-cache-01",
        "cloudCacheInstanceStatusName": "creating",
        "cloudCacheInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE(VPC) Init状態"
        },
        "cloudCacheInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "cloudCacheImageProductCode": "SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050",
        "engineVersion": "VALKEY 7.2.11",
        "license": {
          "code": "BSD",
          "codeName": "ライセンスコード-CLOUD DATABASE(VPC)"
        },
        "cloudCachePort": 13306,
        "isHa": true,
        "cloudCacheServerPrefix": "testcache",
        "generationCode": "G2",
        "role": {
          "code": "CLUSTER",
          "codeName": "Cluster Role-CLOUD Cache(VPC)"
        },
        "createDate": "2026-06-10T14:46:18+0900",
        "accessControlGroupNoList": [],
        "masterNodeCount": 3,
        "slaveNodeCount": 3,
        "configGroupNo": "11099",
        "configGroupName": "test-cfg-01",
        "cloudCacheServerInstanceList": [
          {
            "cloudCacheServerName": "testcache-001-001-98g5",
            "cloudCacheServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudCacheServerInstanceStatusName": "creating",
            "cloudCacheServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "createDate": "2026-06-10T14:46:18+0900"
          },
          {
            "cloudCacheServerName": "testcache-002-001-98g6",
            "cloudCacheServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudCacheServerInstanceStatusName": "creating",
            "cloudCacheServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "createDate": "2026-06-10T14:46:18+0900"
          },
          {
            "cloudCacheServerName": "testcache-003-001-98g7",
            "cloudCacheServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudCacheServerInstanceStatusName": "creating",
            "cloudCacheServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "createDate": "2026-06-10T14:46:18+0900"
          },
          {
            "cloudCacheServerName": "testcache-001-002-98g8",
            "cloudCacheServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudCacheServerInstanceStatusName": "creating",
            "cloudCacheServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "createDate": "2026-06-10T14:46:18+0900"
          },
          {
            "cloudCacheServerName": "testcache-002-002-98g9",
            "cloudCacheServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudCacheServerInstanceStatusName": "creating",
            "cloudCacheServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "createDate": "2026-06-10T14:46:18+0900"
          },
          {
            "cloudCacheServerName": "testcache-003-002-98ga",
            "cloudCacheServerRole": {
              "code": "S",
              "codeName": "Slave"
            },
            "cloudCacheServerInstanceStatusName": "creating",
            "cloudCacheServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
            },
            "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "createDate": "2026-06-10T14:46:18+0900"
          }
        ]
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

createCloudRedisInstance CLI

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

構文

createCloudRedisInstance構文は次の通りです。

./ncloud vredis createCloudRedisInstance \
    --vpcNo <vpc-no> \
    --subnetNo <subnet-no> \
    --cloudRedisServiceName <service-name> \
    --cloudRedisServerNamePrefix <server-name-prefix> \
    --configGroupNo <config-group-no> \
    --cloudRedisModeCode <SIMPLE|CLUSTER> \
    [--cloudRedisImageProductCode <image-product-code>] \
    [--cloudRedisProductCode <product-code>] \
    [--engineVersionCode <engine-version-code>] \
    [--shardCount <shard-count>] \
    [--shardCopyCount <shard-copy-count>] \
    [--isHa <true|false>] \
    [--isBackup <true|false>] \
    [--isAutomaticBackup <true|false>] \
    [--backupTime <hh:mm>] \
    [--backupFileRetentionPeriod <retention-days>] \
    [--cloudRedisPort <port>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

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

必須オプション

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

オプション タイプ 必須の有無 説明
--vpcNo String Required Cloud DB for Cacheインスタンスを作成する VPC番号
--subnetNo String Required Cloud DB for Cacheインスタンスの Subnet番号
  • Private Subnetでのみ作成可能
  • Cloud DB for Cacheインスタンス作成後に Subnetの移転はできない
  • getCloudCacheTargetSubnetListを参照
--cloudRedisServiceName String Required Cloud DB for Cacheサービスの名前
  • 英数字、ハングル、記号の-を組み合わせて3~15以内で入力
  • DBサービス名は重複して使用不可
--cloudRedisServerNamePrefix String Required Cloud DB for Cacheサーバ名の接頭辞
  • 英字の小文字、数字、記号の-を組み合わせて3~15文字以内で入力
  • 先頭文字は英字、末尾文字は英字または数字のみ使用可能
  • 接頭辞の末尾に3桁の数字が自動で作成される
  • DBサーバ名は重複して使用不可
--configGroupNo String Required Config Group番号
  • DB Server設定を効率的に管理するための Config Groupを提供し、1つのクラスタ群はすべて同じ configを使用
  • Config Groupがない場合は新規作成が必要で、作成後はオンラインで変更可能
  • DB Serverのタイプ(Cluster/Simple)と Cacheエンジンのバージョン情報と一致する Config Group番号を入力
    • 例: DB Serverのタイプが Clusterで、エンジンのバージョンが7.0.15の場合、cloudRedisVersion7.0.15-clusterに対応するconfigGroupNoを入力
  • getCloudCacheConfigGroupListを参照
--cloudRedisModeCode String Required Cloud DB for Cacheモード
  • SIMPLE | CLUSTER
    • SIMPLE: Master、Standby-Master方式を使用する基本 Cache
    • CLUSTER: Master、Slave方式を使用し、データシャーディングによりトラフィックを分散できる Cache
  • CLUSTER設定を使用する場合、高可用性の有無(isHa)が入力されても無視する
--backupTime String Conditional バックアップ時点を設定 (HH:MM)
  • isBackup=trueisAutomaticBackup=falseの場合、必ず入力
  • 例: 01:15 (選択した時間 + 15分の間に Backupが開始)

任意オプション

createCloudRedisInstanceの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--cloudRedisImageProductCode String Optional Cloud DB for Cacheイメージ商品コード
--cloudRedisProductCode String Optional Cloud DB for Cache商品コード
  • Cloud DB for Cacheインスタンスのサーバスペックを決める
  • デフォルト: 最小スペック(メモリ、CPUの順)
  • getCloudCacheProductListを参照
--engineVersionCode String Optional DBエンジンのバージョン
--shardCount Integer Optional DBモードが Clusterの場合、Master Nodeの作成数
  • 3~10 (デフォルト: 3)
  • cloudRedisModeCodeCLUSTERの場合にのみ入力
  • cloudRedisModeCodeSIMPLEの場合、入力されても無視する
--shardCopyCount Integer Optional DBモードが Clusterの場合、Master Nodeのレプリカの Slave nodeの作成数
  • 0~4 (デフォルト: 0)
  • 高可用性(HA)のためには Slave nodeが必要で、レプリカを追加すると、すべての Master Nodeに Slave Nodeが1つずつ割り当てられる
  • 例: シャード3個、シャードごとのレプリカが1個の場合、Master Node 3台、Slave Node 3台
  • 0に設定すると、高可用性はサポートされない
  • cloudRedisModeCodeCLUSTERの場合にのみ入力
  • cloudRedisModeCodeSIMPLEの場合、入力されても無視する
--isHa Boolean Optional 高可用性の有無
  • true | false (デフォルト)
  • 高可用性を選択すると、Standby Masterサーバを利用した自動障害復旧をサポートし、追加料金が発生して自動的にバックアップが設定される
--isBackup Boolean Optional DB Serverのバックアップを設定するか
  • true | false (デフォルト)
  • isHa=trueの場合、trueに固定される
--isAutomaticBackup Boolean Optional バックアップ時点を自動設定するか
  • true (デフォルト) | false
  • trueの場合、backupTimeが入力されても無視し、自動で設定される
--backupFileRetentionPeriod Integer Optional バックアップファイルの保管期間(日)
  • 1~7 (デフォルト: 1)
  • バックアップは毎日行われ、バックアップファイルは別途バックアップストレージに保存
  • 料金は使用する容量だけ課金
--cloudRedisPort Integer Optional Cloud DB for Cacheインスタンスアクセス用の TCPポート番号
  • 10000~20000 (デフォルト: 6379)

共通オプション

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

Cloud DB for Cacheインスタンスの作成リクエストが成功すると、インスタンスの構成情報と作成状態が返されます。

コマンド

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

./ncloud vredis createCloudRedisInstance \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudRedisServiceName test-redis-01 \
    --cloudRedisServerNamePrefix testredis \
    --configGroupNo 11099 \
    --cloudRedisModeCode CLUSTER \
    --cloudRedisImageProductCode SW.VRDS.OS.LNX64.ROCKY.0810.REDIS.B050 \
    --cloudRedisProductCode SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G001 \
    --shardCount 3 \
    --shardCopyCount 1 \
    --isBackup true \
    --isAutomaticBackup true \
    --backupFileRetentionPeriod 1 \
    --cloudRedisPort 13306 \
    --regionCode KR \
    --output json

出力

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

{
  "createCloudRedisInstanceResponse": {
    "totalRows": 1,
    "cloudRedisInstanceList": [
      {
        "cloudRedisInstanceNo": "34567890",
        "cloudRedisServiceName": "test-redis-01",
        "cloudRedisInstanceStatusName": "creating",
        "cloudRedisInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE(VPC) Init状態"
        },
        "cloudRedisInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "cloudRedisImageProductCode": "SW.VRDS.OS.LNX64.ROCKY.0810.REDIS.B050",
        "engineVersion": "REDIS 7.2.11",
        "license": {
          "code": "BSD",
          "codeName": "ライセンスコード-CLOUD DATABASE(VPC)"
        },
        "cloudRedisPort": 6379,
        "isHa": false,
        "cloudRedisServerPrefix": "testredis",
        "generationCode": "G2",
        "role": {
          "code": "SIMPLE",
          "codeName": "Cluster Role-CLOUD Cache(VPC)"
        },
        "createDate": "2026-07-01T11:43:48+0900",
        "accessControlGroupNoList": [],
        "masterNodeCount": 1,
        "slaveNodeCount": 0,
        "configGroupNo": "10001",
        "configGroupName": "test-redis-cfg",
        "cloudRedisServerInstanceList": [
          {
            "cloudRedisServerName": "testredis-001-9c4s",
            "cloudRedisServerRole": {
              "code": "A",
              "codeName": "Stand Alone"
            },
            "cloudRedisServerInstanceStatusName": "creating",
            "cloudRedisServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
            },
            "cloudRedisServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
            },
            "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "cpuCount": 4,
            "memorySize": 1610612736,
            "osMemorySize": 2147483648,
            "createDate": "2026-07-01T11:43:48+0900"
          }
        ]
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}