createCloudRedisInstance
- Print
- PDF
createCloudRedisInstance
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.
Available in VPC
Create a Cloud DB for Redis instance.
Request
The following describes the request format for the endpoint. The request format is as follows:
Method | URI |
---|---|
GET, POST | /createCloudRedisInstance |
Request headers
For headers common to Cloud DB for Redis APIs, see Cloud DB for Redis request headers.
Request parameter
The following describes the parameters.
Field | Type | Required | Description |
---|---|---|---|
regionCode | String | Optional | Region code of the Cloud DB for Redis instance to create
|
vpcNo | String | Required | Number of VPC to create the Cloud DB for Redis instance in
|
cloudRedisImageProductCode | String | Optional | Cloud DB for Redis image product code
|
cloudRedisProductCode | String | Optional | Cloud DB for Redis product code
|
shardCount | Integer | Optional | Number of master nodes created when Redis mode is Cluster
|
shardCopyCount | Integer | Optional | Number of slave nodes that are replicas of the master node when Redis mode is Cluster
|
isHa | Boolean | Optional | High availability status
|
configGroupNo | String | Required | Config group number
|
isBackup | Boolean | Optional | Whether Redis backup is enabled
|
backupFileRetentionPeriod | Integer | Optional | Backup file retention period (days)
|
backupTime | String | Conditional | Set backup time
|
isAutomaticBackup | Boolean | Optional | Whether to set the backup time automatically
|
cloudRedisServiceName | String | Required | Name of the Cloud DB for Redis service to create
|
cloudRedisServerNamePrefix | String | Required | Cloud DB for Redis server name prefix to create
|
cloudRedisPort | Integer | Optional | TCP port number to access the Cloud DB for Redis instance
|
subnetNo | String | Required | Subnet number of the Cloud Redis instance to create
|
engineVersionCode | String | Conditional | Redis engine version
|
cloudRedisModeCode | String | Required | Mode of Cloud DB for Redis to create
|
responseFormatType | String | Optional | Format of the response result
|
Request example
The following is a sample request.
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
The following 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 following is a sample response.
- 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>
Was this article helpful?