createCloudRedisInstance

Article Summary

Share feedback

Thanks for sharing your feedback!

Available in VPC

Overview

Cloud DB for Redis instance is generated.

Requests

Request Parameters

Parameter name	Requirement status	Type	Restrictions	Description
regionCode	No	String		- Region code Sets the region in which a Cloud DB for Redis instance is to be created regionCode can be obtained via the getRegionList action Default: the first Region of the getRegionList search results is selected.
vpcNo	Yes	String		- VPC number Determining the VPC in which the Cloud DB for Redis instance will be created vpcNo can be obtained through the getVpcList action
cloudRedisImageProductCode	No	String		- Cloud Redis image product code The cloudRedisImageProductCode can be obtained via the productCode of the getCloudRedisImageProductList action. Generated in default value if data is not entered.
cloudRedisProductCode	No	String		- Cloud Redis product code Sets the server specifications of the Cloud DB for Redis instance to be created. The cloudRedisProductCode can be obtained via the productCode of the getCloudRedisProductList action Default: the minimum specifications are selected The minimum specifications are: 1. memory, 2. CPU.
shardCount	No	Integer	Min:3, Max: 10	- Number of shards Number of shards to be created. 3 to 10 Number of master nodes Necessary only if the CloudRedisModeCode is CLUSTER. If the CloudRedisModeCode is SIMPLE, even if the shardCount is entered, it is ignored. default: 3
shardCopyCount	No	Integer	Min: 0, Max: 4	- Replicas per shard Redis Cluster consists of the master node and slave node. A slave node is necessary for HA. When adding a replica, one slave node is assigned to each master node. For example, 3 shards, 1 replica per shard -> Master node: 3, Slave node: 3 You can enter 0 to 4 replica(s) for each shard. If the number of replicas per shard is set to 0, then high availability can't be supported. Necessary only if the CloudRedisModeCode is CLUSTER. If the CloudRedisModeCode is SIMPLE, even if the shardCopyCount is entered, it is ignored. default: 0
isHa	No	Boolean		- High availability status The Cloud DB for Redis product supports automatic failure recovery using the Standby master. When high availability is supported, additional charges are incurred and backup is automatically configured. Default: false
configGroupNo	Yes	String		- ConfigGroup number Config groups are provided, and one cluster group uses the same config. A new config group must be created if none exists. It can be changed online after creation.
isBackup	No	Boolean		- Backup status If the high availability status (isHa) is True, then the backup setting status is fixed as True. default : false
backupFileRetentionPeriod	No	Integer	Min: 1, Max: 7	- Backup file retention period Backups are performed on a daily basis, and backup files are stored in a separate backup storage. Charges are based on the storage space used Default: 1 (1 day)
backupTime	Conditional	String		- Backup time Set the time to perform backup This field must be entered when the backup status (isBackup) is true and the automatic backup status (isAutomaticBackup) is false. Example 01:15
isAutomaticBackup	No	Boolean		- Automatic backup time status Select whether to have backup times set automatically. When the automatic backup status (isAutomaticBackup) is true, then any backupTime entered is ignored and the backup time is configured automatically.
cloudRedisServiceName	Yes	String	Only alphanumeric characters, numbers, hyphens (-), and Korean characters are allowed. Min: 3, Max: 15	- Cloud Redis service name Enter the group name of the Redis server (e.g., NAVER-HOME). You can enter 3 to 15 characters. You cannot double-use the Redis service name.
cloudRedisServerNamePrefix	Yes	String	It must only contain English letters (lowercase), numbers, and hyphens (-). It must start with an English letter and end with an English letter or a number. Min: 3, Max: 15	- Cloud Redis server name Enter the name prefix of the Redis Server. You can enter 3 to 15 characters. The Redis server name is created with a 3-digit number, which is automatically created. You cannot double-use the Redis Server name.
cloudRedisPort	No	Integer	6379 or Min: 10000, Max: 20000	- Cloud Redis port You need to enter the TCP port number of Redis access. Default: 6379
subnetNo	Yes	String		- Subnet number Sets the subnet of the Cloud Redis instance to be created. The subnetNo can be obtained through the getSubnetList action. A public domain can only be used with a DB server created in a public subnet. Subnet transfer is not possible after a Cloud DB for Redis instance has been created.
engineVersionCode	No	String		- Engine Version - The getCloudRedisImageProductList can be obtained through the getCloudRedisImageProductList action. Necessary only if the generationCode of the cloudRedisImageProductCode is G3. If an entry is not made, then it is generated in the latest currently available version.
cloudRedisModeCode	Yes	String		- Configuration of Cloud DB for Redis Determines the configuration of Cloud DB for Redis. When the CLUSTER setting is used, the isHa setting is ignored. Options: CLUSTER, SIMPLE
responseFormatType	No	String		- Format type of the response result Options: xml \| json Default: xml

Responses

Response bodies

CloudRedisInstanceList

Examples

Request Examples

GET {API_URL}/createCloudRedisInstance
?regionCode=KR
&vpcNo=****83
&cloudRedisImageProductCode=SW.VDBAS.VRDS.LNX64.CNTOS.0703.REDIS.4014.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

Response examples


<createCloudRedisInstanceResponse>
    <requestId>0a3318fc-7176-4e2d-8c55-925209e53115</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.0703.REDIS.4014.B050</cloudRedisImageProductCode>
            <engineVersion>REDIS 4.0.14</engineVersion>
            <licence>
                <code>BSD</code>
                <codeName>Berkeley Software Distribution</codeName>
            </licence>
            <cloudRedisPort>6379</cloudRedisPort>
            <isHa>false</isHa>
            <cloudRedisServerPrefix>test-****</cloudRedisServerPrefix>
            <role>
                <code>CLUSTER</code>
                <codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
            </role>
            <createDate>2021-04-21T15:05:31+0900</createDate>
            <masterNodeCount>3</masterNodeCount>
            <slaveNodeCount>3</slaveNodeCount>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>test-****-config</configGroupName>
            <generationCode>G2</generationCode>
            <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>****91</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2021-04-21T15:05:31+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>****91</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2021-04-21T15:05:31+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>****91</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2021-04-21T15:05:31+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>****91</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2021-04-21T15:05:31+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>****91</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2021-04-21T15:05:31+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>****91</subnetNo>
                    <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <createDate>2021-04-21T15:05:31+0900</createDate>
                </cloudRedisServerInstance>
            </cloudRedisServerInstanceList>
        </cloudRedisInstance>
    </cloudRedisInstanceList>
</createCloudRedisInstanceResponse>

Was this article helpful?

What's Next

deleteCloudRedisConfigGroup

Table of contents

Overview
Requests
Responses
Examples