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

Available in VPC

Create a Cloud DB for Cache instance.

Note

Cloud DB for Cache CLI offers two versions based on the supported DBMS range.

  • createCloudCacheInstance CLI: Support for Valkey and Redis DBMS
  • createCloudRedisInstance CLI: Support for Redis DBMS

createCloudCacheInstance CLI

This section describes the command syntax, options, commands, and output examples for the createCloudCacheInstance CLI.

Syntax

The createCloudCacheInstance syntax is as follows:

./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>]

Options

This section describes the options available when running createCloudCacheInstance.

Required options

The following options are required for createCloudCacheInstance.

Options Type Required Description
--vpcNo String Required Number of VPC on which to create the Cloud DB for Cache instance
--subnetNo String Required Subnet number of the Cloud DB for Cache instance
  • Can only be created in a private subnet.
  • Subnet migrations are not available after creating the Cloud DB for Cache instance.
  • See getCloudCacheTargetSubnetList.
--cloudCacheServiceName String Required Cloud DB for Cache service name
  • Enter 3-15 characters, including English letters, Korean letters, numbers, and special character -.
  • DB service names cannot be used in duplicate.
--cloudCacheServerNamePrefix String Required Cloud DB for Cache server name prefix
  • Enter 3-15 characters, including lowercase English letters, numbers, and special character -.
  • The string must begin with an English letter and end with an English letter or number.
  • A 3-digit number is automatically generated after the prefix.
  • DB service names cannot be used in duplicate.
--configGroupNo String Required Config group number
  • Config groups are provided to efficiently manage DB server settings, and one cluster group will all use the same config.
  • If a config group does not exist, it must be created and can be changed online even after creation.
  • DB server's type (Cluster/Simple) and Cache engine version information must be entered to match the config group number.
    • Example: If the DB server type is "Cluster" and engine version is 7.0.15, enter the configGroupNo value such that cloudCacheVersion corresponds to 7.0.15-cluster.
  • See getCloudCacheConfigGroupList.
--cloudCacheModeCode String Required Cloud DB for Cache mode
  • SIMPLE | CLUSTER
    • SIMPLE: Basic Cache with master, standby-master architecture
    • CLUSTER: Cache with a master, slave architecture and data sharding to offload traffic
  • When using the CLUSTER setting, it ignores the high availability status (isHa) even if it's entered.
--engineVersionCode String Conditional DB engine version
  • If not entered, it is created with the latest version currently available.
  • Required if generationCode of cloudCacheImageProductCode is G3.
  • See getCloudCacheImageProductList.
--backupTime String Conditional Set backup time (HH:MM).
  • Required if isBackup=true and isAutomaticBackup=false.
  • e.g., 01:15 (Backup starts between the selected time + 15 minutes.)

Optional options

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

Options Type Required Description
--cloudCacheImageProductCode String Optional Cloud DB for Cache image product code
--cloudCacheProductCode String Optional Cloud DB for Cache product code
  • Determin the server specifications for the Cloud DB for Cache.
  • Default: Minimum specifications (in the order of memory, CPU).
  • See getCloudCacheProductList.
--shardCount Integer Optional Number of master nodes created when DB mode is Cluster
  • 3-10 (default: 3)
  • Enter only when cloudCacheModeCode is CLUSTER.
  • If cloudCacheModeCode is SIMPLE, it is ignored even if it's entered.
--shardCopyCount Integer Optional Number of slave nodes that are replicas of the master node when DB mode is Cluster
  • 0-4 (default: 0)
  • Slave nodes required for high availability (HA), and when a replica is added, one slave node is assigned to each master node.
  • Example: If there are 3 shards, with 1 replica per shard, then 3 master nodes and 3 slave nodes are required.
  • High availability is not supported if set to 0.
  • Enter only when cloudCacheModeCode is CLUSTER.
  • If cloudCacheModeCode is SIMPLE, it is ignored even if it's entered.
--isHa Boolean Optional High availability status
  • true | false (default)
  • When high availability is selected, automatic failover with a standby master server is supported for an additional fee and backups are set up automatically.
--isBackup Boolean Optional Whether DB server backup is enabled
  • true | false (default)
  • If isHa=true, it is fixed to true.
--isAutomaticBackup Boolean Optional Whether to set the backup time automatically
  • true (default) | false
  • If set to true, it will ignore even if backupTime is entered and set automatically.
--backupFileRetentionPeriod Integer Optional Backup file retention period (days)
  • 1-7 (default: 1)
  • Backup is performed every day, and the backup file is stored in a separate backup storage.
  • Fees are charged for the space you use.
--cloudCachePort Integer Optional TCP port number to access the Cloud DB for Cache instance
  • 10000-20000 (default: 6379)
--cloudCacheDbmsCode String Optional Cloud DB for Cache instance's DBMS code
  • Redis (default) | Valkey

Common options

For information about the options common to all vcache subcommands, see Cloud DB for Cache (VPC) options.

Examples

If the request to create a Cloud DB for Cache instance is successful, the instance's configuration information and creation status are returned.

Command

The command example is as follows:

./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

Output

The output example is as follows:

{
  "createCloudCacheInstanceResponse": {
    "totalRows": 1,
    "cloudCacheInstanceList": [
      {
        "cloudCacheInstanceNo": "34567890",
        "cloudCacheServiceName": "test-cache-01",
        "cloudCacheInstanceStatusName": "creating",
        "cloudCacheInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE (VPC) Init status"
        },
        "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": "License code - 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) server Pending status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server 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) server Pending status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server 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) server Pending status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server 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) server Pending status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server 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) server Pending status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server 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) server Pending status"
            },
            "cloudCacheServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server 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

This section describes the command syntax, options, commands, and output examples for the createCloudRedisInstance CLI.

Syntax

The createCloudRedisInstance syntax is as follows:

./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>]

Options

This section describes the options available when running createCloudRedisInstance.

Required options

The following options are required for createCloudRedisInstance.

Options Type Required Description
--vpcNo String Required Number of VPC on which to create the Cloud DB for Cache instance
--subnetNo String Required Subnet number of the Cloud DB for Cache instance
  • Can only be created in a private subnet.
  • Subnet migrations are not available after creating the Cloud DB for Cache instance.
  • See getCloudCacheTargetSubnetList.
--cloudRedisServiceName String Required Cloud DB for Cache service name
  • Enter 3-15 characters, including English letters, Korean letters, numbers, and special character -.
  • DB service names cannot be used in duplicate.
--cloudRedisServerNamePrefix String Required Cloud DB for Cache server name prefix
  • Enter 3-15 characters, including lowercase English letters, numbers, and special character -.
  • The string must begin with an English letter and end with an English letter or number.
  • A 3-digit number is automatically generated after the prefix.
  • DB service names cannot be used in duplicate.
--configGroupNo String Required Config group number
  • Config groups are provided to efficiently manage DB server settings, and one cluster group will all use the same config.
  • If a config group does not exist, it must be created and can be changed online even after creation.
  • DB server's type (Cluster/Simple) and Cache engine version information must be entered to match the config group number.
    • Example: If the DB server type is "Cluster" and engine version is 7.0.15, enter the configGroupNo value such that cloudRedisVersion corresponds to 7.0.15-cluster.
  • See getCloudCacheConfigGroupList.
--cloudRedisModeCode String Required Cloud DB for Cache mode
  • SIMPLE | CLUSTER
    • SIMPLE: Basic Cache with master, standby-master architecture
    • CLUSTER: Cache with a master, slave architecture and data sharding to offload traffic
  • When using the CLUSTER setting, it ignores the high availability status (isHa) even if it's entered.
--backupTime String Conditional Set backup time (HH:MM).
  • Required if isBackup=true and isAutomaticBackup=false.
  • e.g., 01:15 (Backup starts between the selected time + 15 minutes.)

Optional options

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

Options Type Required Description
--cloudRedisImageProductCode String Optional Cloud DB for Cache image product code
--cloudRedisProductCode String Optional Cloud DB for Cache product code
  • Determin the server specifications for the Cloud DB for Cache.
  • Default: Minimum specifications (in the order of memory, CPU).
  • See getCloudCacheProductList.
--engineVersionCode String Optional DB engine version
--shardCount Integer Optional Number of master nodes created when DB mode is Cluster
  • 3-10 (default: 3)
  • Enter only when cloudRedisModeCode is CLUSTER.
  • If cloudRedisModeCode is SIMPLE, it is ignored even if it's entered.
--shardCopyCount Integer Optional Number of slave nodes that are replicas of the master node when DB mode is Cluster
  • 0-4 (default: 0)
  • Slave nodes required for high availability (HA), and when a replica is added, one slave node is assigned to each master node.
  • Example: If there are 3 shards, with 1 replica per shard, then 3 master nodes and 3 slave nodes are required.
  • High availability is not supported if set to 0.
  • Enter only when cloudRedisModeCode is CLUSTER.
  • If cloudRedisModeCode is SIMPLE, it is ignored even if it's entered.
--isHa Boolean Optional High availability status
  • true | false (default)
  • When high availability is selected, automatic failover with a standby master server is supported for an additional fee and backups are set up automatically.
--isBackup Boolean Optional Whether DB server backup is enabled
  • true | false (default)
  • If isHa=true, it is fixed to true.
--isAutomaticBackup Boolean Optional Whether to set the backup time automatically
  • true (default) | false
  • If set to true, it will ignore even if backupTime is entered and set automatically.
--backupFileRetentionPeriod Integer Optional Backup file retention period (days)
  • 1-7 (default: 1)
  • Backup is performed every day, and the backup file is stored in a separate backup storage.
  • Fees are charged for the space you use.
--cloudRedisPort Integer Optional TCP port number to access the Cloud DB for Cache instance
  • 10000-20000 (default: 6379)

Common options

For information about the options common to all vredis subcommands, see Cloud DB for Cache (VPC) options.

Examples

If the request to create a Cloud DB for Cache instance is successful, the instance's configuration information and creation status are returned.

Command

The command example is as follows:

./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

Output

The output example is as follows:

{
  "createCloudRedisInstanceResponse": {
    "totalRows": 1,
    "cloudRedisInstanceList": [
      {
        "cloudRedisInstanceNo": "34567890",
        "cloudRedisServiceName": "test-redis-01",
        "cloudRedisInstanceStatusName": "creating",
        "cloudRedisInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE (VPC) Init status"
        },
        "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": "License code - 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) server Pending status"
            },
            "cloudRedisServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server 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"
  }
}
Business Registration Number: 129-86-31394 E-commerce Permit Number:No. 2009-GyeonggiSeongnam-0510
CEO: Kim Yuwon Address: NAVER Green Factory 17th–26th Floors, Buljeong-ro 6, Bundang-gu, Seongnam-si, Gyeonggi-do 13561, Republic of Korea. Customer Support Number: 1544-5876
© NAVER Cloud Corp. All Rights Reserved.