createCloudCacheInstance

Prev Next

Available in VPC

Create a Cloud DB for Cache instance.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET, POST /createCloudRedisInstance

Request headers

For information about the headers common to all Cloud DB for Cache APIs, see Cloud DB for Cache request headers.

Request parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code of the Cloud DB for Cache instance to create
  • Check through getRegionList.
  • First Region of the getRegionList query result (default)
vpcNo String Required Number of VPC on which to create the Cloud DB for Cache instance
cloudRedisImageProductCode String Optional Cloud DB for Cache image product code
cloudRedisProductCode String Optional Cloud DB for Cache product code
  • Check through getCloudCacheProductList.
  • Minimum specification (default)
  • Minimum specification is based on 1. memory and 2. CPU.
shardCount Integer Optional Number of master nodes created when Redis mode is Cluster
  • 3-10 (default: 3)
  • Enter only when CloudRedisModeCode is CLUSTER.
  • If CloudRedisModeCode is SIMPLE, shardCount is ignored even if it's entered.
shardCopyCount Integer Optional Number of slave nodes that are replicas of the master node when Redis mode is Cluster
  • 0-4 (default: 0)
  • Redis Cluster consists of master nodes and slave nodes, and slave nodes are required for high availability (HA).
  • When adding replicas, all master nodes are assigned one slave node each.
  • Example: For 3 shards and 1 replicas per shard
    • Master node: 3
    • Slave node: 3
  • High availability is not supported if replicas per shard is set to 0.
  • Enter only when CloudRedisModeCode is CLUSTER.
  • If CloudRedisModeCode is SIMPLE, shardCopyCount 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.
configGroupNo String Required Config group number
  • Check through getCloudCacheConfigGroupList.
  • Config groups are provided to efficiently manage Redis 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.
  • Redis server's type (Cluster/Simple) and Redis engine version information must be entered to match the config group number.
    • Example: If the Redis server type is "Cluster" and Redis engine version is "7.0.15," enter the configGroupNo value such that cloudRedisVersion corresponds to 7.0.15-cluster.
isBackup Boolean Optional Whether Redis backup is enabled
  • true | false (default)
  • If the high availability status (isHa) is true, the backup status (isBackup) is fixed to true.
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.
backupTime String Conditional Set backup time.
  • true (default) | false
  • Required if the backup status (isBackup) is true and automatic backup status (isAutomaticBackup) is false
  • e.g., 01:15 (Backup starts between the selected time + 15 minutes)
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 will be set automatically.
cloudRedisServiceName String Required Name of the Cloud DB for Cache service to create
  • 3 to 15 characters, including English letters, Korean letters, numbers, and special character "-".
  • Redis service names cannot be used in duplicate.
cloudRedisServerNamePrefix String Required Cloud DB for Cache server name prefix to create
  • 3 to 15 characters, including lowercase English letters, numbers, and the special character "-", and must begin with an English letter and end with an English letter or number.
  • A 3-digit number is automatically generated after the prefix.
  • Redis service names cannot be used in duplicate.
cloudRedisPort Integer Optional TCP port number to access the Cloud DB for Cache instance
  • 6379 (default)
  • Specified range: 10000-20000
subnetNo String Required Subnet number of the Cloud Redis instance to create
  • Check through the getCloudCacheTargetSubnetList action.
  • Can only be created in a private subnet.
  • Subnet migrations are not available after creating the Cloud DB for Cache instance.
engineVersionCode String Conditional Redis engine version
cloudRedisModeCode String Required Mode of Cloud DB for Cache to create
  • CLUSTER | SIMPLE
    • CLUSTER: Redis with a master, slave architecture and data sharding to offload traffic
    • SIMPLE: basic Redis with master, standby-master architecture
  • When using the CLUSTER setting, it ignores the high availability status (isHa) even if it's entered.
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/createCloudRedisInstance
?regionCode=KR
&vpcNo=****83
&cloudRedisImageProductCode=SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050
&cloudRedisProductCode=SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
&shardCount=3
&shardCopyCount=1
&isHa=true
&configGroupNo=***9
&isBackup=true
&backupFileRetentionPeriod=7
&backupTime=00:15
&isAutomaticBackup=true
&cloudRedisServiceName=test-****
&cloudRedisServerNamePrefix=test-****
&cloudRedisPort=6379
&subnetNo=****91
&cloudRedisModeCode=CLUSTER'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

See CloudRedisInstanceList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The response example is as follows:

  • If responseFormatType=json

    {
    "createCloudRedisInstanceResponse": {
        "totalRows": 1,
        "cloudRedisInstanceList": [
            {
                "cloudRedisInstanceNo": "****511",
                "cloudRedisServiceName": "test-****",
                "cloudRedisInstanceStatusName": "creating",
                "cloudRedisInstanceStatus": {
                    "code": "INIT",
                    "codeName": "CLOUD DATABASE(VPC) Init State"
                },
                "cloudRedisInstanceOperation": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Creat OP"
                },
                "cloudRedisImageProductCode": "SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050",
                "engineVersion": "REDIS 7.0.15",
                "licence": {
                    "code": "BSD",
                    "codeName": "Berkeley Software Distribution"
                },
                "cloudRedisPort": 6379,
                "isHa": true,
                "cloudRedisServerPrefix": "test-****",
                "generationCode": "G2",
                "role": {
                    "code": "CLUSTER",
                    "codeName": "CLOUD REDIS(VPC) Cluster Role"
                },
                "createDate": "2024-07-01T16:59:21+0900",
                "accessControlGroupNoList": [],
                "masterNodeCount": 3,
                "slaveNodeCount": 3,
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "cloudRedisServerInstanceList": [
                    {
                        "cloudRedisServerName": "test-****-001-001-ehd",
                        "cloudRedisServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudRedisServerInstanceStatusName": "creating",
                        "cloudRedisServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                        },
                        "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "***83",
                        "subnetNo": "****91",
                        "privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "createDate": "2024-07-01T16:59:21+0900"
                    },
                    {
                        "cloudRedisServerName": "test-****-002-001-ehe",
                        "cloudRedisServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudRedisServerInstanceStatusName": "creating",
                        "cloudRedisServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                        },
                        "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "createDate": "2024-07-01T16:59:21+0900"
                    },
                    {
                        "cloudRedisServerName": "test-****-003-001-ehf",
                        "cloudRedisServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudRedisServerInstanceStatusName": "creating",
                        "cloudRedisServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                        },
                        "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "createDate": "2024-07-01T16:59:21+0900"
                    },
                    {
                        "cloudRedisServerName": "test-****-001-002-ehg",
                        "cloudRedisServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudRedisServerInstanceStatusName": "creating",
                        "cloudRedisServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                        },
                        "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "createDate": "2024-07-01T16:59:21+0900"
                    },
                    {
                        "cloudRedisServerName": "test-****-002-002-ehh",
                        "cloudRedisServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudRedisServerInstanceStatusName": "creating",
                        "cloudRedisServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                        },
                        "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "createDate": "2024-07-01T16:59:21+0900"
                    },
                    {
                        "cloudRedisServerName": "test-****-003-002-ehi",
                        "cloudRedisServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudRedisServerInstanceStatusName": "creating",
                        "cloudRedisServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                        },
                        "cloudRedisServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                        },
                        "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "createDate": "2024-07-01T16:59:21+0900"
                    }
                ]
            }
        ],
        "requestId": "6aaac383-****-****-****-e7b07eea5c35",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

  • If responseFormatType=xml (default)

    <?xml version="1.0" encoding="UTF-8"?>
<createCloudRedisInstanceResponse>
    <requestId>6aaac383-****-****-****-e7b07eea5c35</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisInstanceList>
        <cloudRedisInstance>
            <cloudRedisInstanceNo>****511</cloudRedisInstanceNo>
            <cloudRedisServiceName>test-****</cloudRedisServiceName>
            <cloudRedisInstanceStatusName>creating</cloudRedisInstanceStatusName>
            <cloudRedisInstanceStatus>
                <code>INIT</code>
                <codeName>CLOUD DATABASE(VPC) Init State</codeName>
            </cloudRedisInstanceStatus>
            <cloudRedisInstanceOperation>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Creat OP</codeName>
            </cloudRedisInstanceOperation>
            <cloudRedisImageProductCode>SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050</cloudRedisImageProductCode>
            <engineVersion>REDIS 7.0.15</engineVersion>
            <licence>
                <code>BSD</code>
                <codeName>Berkeley Software Distribution</codeName>
            </licence>
            <cloudRedisPort>6379</cloudRedisPort>
            <isHa>true</isHa>
            <cloudRedisServerPrefix>test-****</cloudRedisServerPrefix>
            <generationCode>G2</generationCode>
            <role>
                <code>CLUSTER</code>
                <codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
            </role>
            <createDate>2024-07-01T16:59:21+0900</createDate>
            <accessControlGroupNoList/>
            <masterNodeCount>3</masterNodeCount>
            <slaveNodeCount>3</slaveNodeCount>
            <configGroupNo>***9</configGroupNo>
            <configGroupName>test-***-config</configGroupName>
            <cloudRedisServerInstanceList>
                <cloudRedisServerInstance>
                    <cloudRedisServerName>test-****-001-001-ehd</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode> KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerName>test-****-002-001-ehe</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerName>test-****-003-001-ehf</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerName>test-****-001-002-ehg</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerName>test-****-002-002-ehh</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                </cloudRedisServerInstance>
                <cloudRedisServerInstance>
                    <cloudRedisServerName>test-****-003-002-ehi</cloudRedisServerName>
                    <cloudRedisServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudRedisServerRole>
                    <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                    <cloudRedisServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudRedisServerInstanceStatus>
                    <cloudRedisServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudRedisServerInstanceOperation>
                    <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                </cloudRedisServerInstance>
            </cloudRedisServerInstanceList>
        </cloudRedisInstance>
    </cloudRedisInstanceList>
</createCloudRedisInstanceResponse>