---
title: "createCloudCacheInstance"
slug: "database-vcache-createcloudcacheinstance"
tags: ["Cloud DB for Cache"]
updated: 2026-09-17T09:16:23Z
published: 2026-09-17T09:16:23Z
canonical: "api.ncloud-docs.com/database-vcache-createcloudcacheinstance"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.
# createCloudCacheInstance
VPC 환경에서 이용 가능합니다.
Cloud DB for Cache 인스턴스를 생성합니다.
참고
Cloud DB for Cache API는 지원하는 DBMS 범위에 따라 두 가지 버전을 제공합니다.
- createCloudCacheInstance API: Valkey, Redis DBMS 이용 가능
- createCloudRedisInstance API: Redis DBMS 이용 가능
## createCloudCacheInstance API
createCloudCacheInstance API의 요청, 응답 형식을 설명합니다.
### 요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
| --- | --- |
| GET \| POST | /vcache/v2/createCloudCacheInstance |
참고
가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.
### 요청 헤더
Cloud DB for Cache (VPC) API에서 공통으로 사용하는 헤더에 대한 정보는 [Cloud DB for Cache (VPC) 요청 헤더](/docs/database-vcache#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.
#### 요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 생성할 Cloud DB for Cache 인스턴스의 리전 코드 - [getRegionList](/docs/compute-vserver-server-common-getregionlist) 참조 - `getRegionList` 조회 결과의 첫 번째 리전(기본값) |
| `vpcNo` | String | Required | Cloud DB for Cache 인스턴스를 생성할 VPC 번호 - [getCloudCacheTargetVpcList](/docs/database-vcache-getcloudcachetargetvpclist) 참조 |
| `cloudCacheImageProductCode` | String | Optional | Cloud DB for Cache 이미지 상품 코드 - [getCloudCacheImageProductList](/docs/database-vcache-getcloudcacheimageproductlist) 참조 - 네이버 클라우드 플랫폼에서 자동 생성(기본값) |
| `cloudCacheProductCode` | String | Optional | Cloud DB for Cache 상품 코드 - [getCloudCacheProductList](/docs/database-vcache-getcloudcacheproductlist) 참조 - 최소 사양(기본값) - 최소 사양의 기준: 1. 메모리 2. CPU 순서로 결정 |
| `shardCount` | Integer | Optional | DB 모드가 Cluster인 경우 Master Node의 생성 개수 - 3~10 (기본값: 3) - `CloudCacheModeCode`가 `CLUSTER`인 경우에만 입력 - `CloudCacheModeCode`가 `SIMPLE`인 경우 `shardCount`가 입력되어도 무시함 |
| `shardCopyCount` | Integer | Optional | DB 모드가 Cluster인 경우 Master Node 복제본인 Slave node의 생성 개수 - 0~4 (기본값: 0) - Cluster는 Master node와 Slave node로 구성되어 있으며, 고가용성(HA)을 위해서는 Slave node가 필요 - 복제본 추가 시 모든 Master node에 각각 1개씩 Slave node가 할당됨 - <예시> 샤드 3개, 샤드당 복제본 1개인 경우 - Master node: 3대 - Slave node: 3대 - 샤드당 복제본을 `0`으로 설정하면 고가용성 지원이 되지 않음 - `CloudCacheModeCode`가 `CLUSTER`인 경우에만 입력 - `CloudCacheModeCode`가 `SIMPLE`이면 `shardCopyCount`가 입력되어도 무시함 |
| `isHa` | Boolean | Optional | 고가용성 여부 - `true` \| `false` (기본값) - 고가용성 선택 시, Standby Master 서버를 이용한 자동 장애 복구를 지원하며, 추가 요금 발생 및 자동으로 백업이 설정됨 |
| `configGroupNo` | String | Required | Config Group 번호 - [getCloudCacheConfigGroupList](/docs/database-vcache-getcloudcacheconfiggrouplist) 참조 - DB Server 설정을 효율적으로 관리하기 위한 Config Group을 제공하며, 하나의 클러스터군은 모두 같은 config를 사용하게 됨 - Config Group이 없는 경우, 새로 생성해야 하며 생성 후에도 온라인으로 변경 가능 - DB Server의 타입(Cluster/Simple) 및 Cache 엔진 버전 정보와 일치하는 Config Group 번호를 입력해야 함 |
| `isBackup` | Boolean | Optional | DB Server의 백업 설정 여부 - `true` \| `false`(기본값) - 고가용성 여부(`isHa`)가 `true`일 경우 백업 여부(isBackup)는 `true`로 고정됨 |
| `backupFileRetentionPeriod` | Integer | Optional | 백업 파일 보관 기간(일) - 1~7 (기본값: 1) - 백업은 매일 수행되며, 백업 파일은 별도의 백업 스토리지에 저장됨 - 요금은 사용하는 공간만큼만 과금됨 |
| `backupTime` | String | Conditional | 백업 시점 설정 - `true` (기본값) \| `false` - 백업 여부(`isBackup`)가 `true`, 자동 백업 여부(`isAutomaticBackup`)가 `false`인 경우 필수 입력 - <예시>01:15 (선택한 시간 + 15분 사이에 Backup이 시작) |
| `isAutomaticBackup` | Boolean | Optional | 백업 시점 자동 설정 여부 - `true` (기본값) \| `false` - 설정 값이 `true`인 경우, `backupTime`가 입력되어도 무시하며 자동으로 설정됨 |
| `cloudCacheServiceName` | String | Required | 생성할 Cloud DB for Cache 서비스 이름 - 영문자, 숫자, 한글, 특수 문자 '-'를 조합하여 3~15자 이내로 입력 - DB 서비스 이름은 중복으로 사용 불가 |
| `cloudCacheServerNamePrefix` | String | Required | 생성할 Cloud DB for Cache 서버 이름 접두사 - 영문 소문자, 숫자, 특수 문자 '-'를 조합하여 3~15자 이내로 입력 - 문자열은 영문자로 시작해서 영문자 또는 숫자로 끝나야 함 - 접두사 뒤에 3자리 숫자가 자동으로 생성됨 - DB 서버 이름은 중복으로 사용 불가 |
| `cloudCachePort` | Integer | Optional | Cloud DB for Cache 인스턴스에 접근하기 위한 TCP 포트 번호 - 6379 (기본값) - 지정 범위: 10000~20000 |
| `subnetNo` | String | Required | 생성할 Cloud Cache 인스턴스의 Subnet 번호 - [getCloudCacheTargetSubnetList](/docs/database-vcache-getcloudcachetargetsubnetlist) 액션을 통해서 확인 - Private Subnet에서만 생성 가능 - Cloud DB for Cache 인스턴스 생성 이후에 Subnet 이전 불가능 |
| `engineVersionCode` | String | Conditional | Cache 엔진 버전 - [getCloudCacheImageProductList](/docs/database-vcache-getcloudcacheimageproductlist) 참조 - 미입력 시 현재 제공 중인 최신 버전으로 생성 |
| `cloudCacheModeCode` | String | Required | 생성할 Cloud DB for Cache 모드 - `SIMPLE` \| `CLUSTER` - `CLUSTER` 설정 사용 시, 고가용성 여부(`isHa`)가 입력되어도 무시함 |
| `cloudCacheDbmsCode` | String | Optional | Cloud DB for Cache 인스턴스의 DBMS 코드 - `Redis` (기본값) \| `Valkey` |
| `responseFormatType` | String | Optional | 응답 결과의 형식 - `xml` (기본값) \| `json` |
| `generationCode` | String | Optional | 서버 세대 - G2 - G3 |
#### 요청 예시
요청 예시는 다음과 같습니다.
```
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/createCloudCacheInstance
?regionCode=KR
&vpcNo=****83
&cloudCacheImageProductCode=SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050
&cloudCacheProductCode=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
&cloudCacheServiceName=test-****
&cloudCacheServerNamePrefix=test-****
&cloudCachePort=6379
&subnetNo=****91
&cloudCacheDbmsCode=Valkey
&cloudCacheModeCode=SIMPLE' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```
### 응답
응답 형식을 설명합니다.
#### 응답 바디
응답 바디는 [CloudCacheInstanceList](/docs/common-vapidatatype-cloudcacheinstancelist)를 참조해 주십시오.
#### 응답 상태 코드
Cloud DB for Cache (VPC) API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Cloud DB for Cache (VPC) 응답 상태 코드](/docs/database-vcache#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오.
#### 응답 예시
응답 예시는 다음과 같습니다.
- `responseFormatType=json` 일 때
```
{
"createCloudCacheInstanceResponse": {
"totalRows": 1,
"cloudCacheInstanceList": [
{
"cloudCacheInstanceNo": "****511",
"cloudCacheServiceName": "test-****",
"cloudCacheInstanceStatusName": "creating",
"cloudCacheInstanceStatus": {
"code": "INIT",
"codeName": "CLOUD DATABASE(VPC) Init State"
},
"cloudCacheInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Creat OP"
},
"cloudCacheImageProductCode": "SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050",
"engineVersion": "VALKEY 7.2.11",
"licence": {
"code": "BSD",
"codeName": "Berkeley Software Distribution"
},
"cloudCachePort": 6379,
"isHa": true,
"cloudCacheServerPrefix": "test-****",
"generationCode": "G2",
"role": {
"code": "CLUSTER",
"codeName": "CLOUD CACHE(VPC) Cluster Role"
},
"createDate": "2024-07-01T16:59:21+0900",
"accessControlGroupNoList": [],
"masterNodeCount": 3,
"slaveNodeCount": 3,
"configGroupNo": "***9",
"configGroupName": "test-***-config",
"cloudCacheServerInstanceList": [
{
"cloudCacheServerName": "test-****-001-001-ehd",
"cloudCacheServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudCacheServerInstanceStatusName": "creating",
"cloudCacheServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudCacheServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "***83",
"subnetNo": "****91",
"privateDomain": "cachec-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
},
{
"cloudCacheServerName": "test-****-002-001-ehe",
"cloudCacheServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudCacheServerInstanceStatusName": "creating",
"cloudCacheServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudCacheServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "****83",
"subnetNo": "****91",
"privateDomain": "cachec-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
},
{
"cloudCacheServerName": "test-****-003-001-ehf",
"cloudCacheServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudCacheServerInstanceStatusName": "creating",
"cloudCacheServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudCacheServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "****83",
"subnetNo": "****91",
"privateDomain": "cachec-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
},
{
"cloudCacheServerName": "test-****-001-002-ehg",
"cloudCacheServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudCacheServerInstanceStatusName": "creating",
"cloudCacheServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudCacheServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "****83",
"subnetNo": "****91",
"privateDomain": "cachec-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
},
{
"cloudCacheServerName": "test-****-002-002-ehh",
"cloudCacheServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudCacheServerInstanceStatusName": "creating",
"cloudCacheServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudCacheServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "****83",
"subnetNo": "****91",
"privateDomain": "cachec-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
},
{
"cloudCacheServerName": "test-****-003-002-ehi",
"cloudCacheServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudCacheServerInstanceStatusName": "creating",
"cloudCacheServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudCacheServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "****83",
"subnetNo": "****91",
"privateDomain": "cachec-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
}
]
}
],
"requestId": "6aaac383-****-****-****-e7b07eea5c35",
"returnCode": "0",
"returnMessage": "success"
}
}
```
- `responseFormatType=xml` (기본값) 일 때
```
6aaac383-****-****-****-e7b07eea5c35
0
success
1
****511
test-****
creating
INIT
CLOUD DATABASE(VPC) Init State
CREAT
CLOUD DATABASE(VPC) Creat OP
SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050
VALKEY 7.2.11
BSD
Berkeley Software Distribution
6379
true
test-****
G2
CLUSTER
CLOUD CACHE(VPC) Cluster Role
2024-07-01T16:59:21+0900
3
3
***9
test-***-config
test-****-001-001-ehd
M
Master
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
cachec-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
test-****-002-001-ehe
M
Master
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
cachec-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
test-****-003-001-ehf
M
Master
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
cachec-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
test-****-001-002-ehg
S
Slave
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
cachec-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
test-****-002-002-ehh
S
Slave
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
cachec-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
test-****-003-002-ehi
S
Slave
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
cachec-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
```
## createCloudRedisInstance API
createCloudRedisInstance API의 요청, 응답 형식을 설명합니다.
### 요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
| --- | --- |
| GET \| POST | /vredis/v2/createCloudRedisInstance |
참고
가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.
### 요청 헤더
Cloud DB for Cache API에서 공통으로 사용하는 헤더에 대한 정보는 [Cloud DB for Cache 요청 헤더](/docs/database-vcache#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.
#### 요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 생성할 Cloud DB for Cache 인스턴스의 리전 코드 - [getRegionList](/docs/compute-vserver-server-common-getregionlist) 참조 - `getRegionList` 조회 결과의 첫 번째 리전(기본값) |
| `vpcNo` | String | Required | Cloud DB for Cache 인스턴스를 생성할 VPC 번호 - [getCloudCacheTargetVpcList](/docs/database-vcache-getcloudcachetargetvpclist) 참조 |
| `cloudRedisImageProductCode` | String | Optional | Cloud DB for Cache 이미지 상품 코드 - [getCloudCacheImageProductList](/docs/database-vcache-getcloudcacheimageproductlist) 참조 - 네이버 클라우드 플랫폼에서 자동 생성(기본값) |
| `cloudRedisProductCode` | String | Optional | Cloud DB for Cache 상품 코드 - [getCloudCacheProductList](/docs/database-vcache-getcloudcacheproductlist) 참조 - 최소 사양(기본값) - 최소 사양의 기준: 1. 메모리 2. CPU 순서로 결정 |
| `shardCount` | Integer | Optional | Redis 모드가 Cluster인 경우 Master Node의 생성 개수 - 3~10 (기본값: 3) - `CloudRedisModeCode`가 `CLUSTER`인 경우에만 입력 - `CloudRedisModeCode`가 `SIMPLE`인 경우 `shardCount`가 입력되어도 무시함 |
| `shardCopyCount` | Integer | Optional | Redis 모드가 Cluster인 경우 Master Node 복제본인 Slave node의 생성 개수 - 0~4 (기본값: 0) - Redis Cluster는 Master node와 Slave node로 구성되어 있으며, 고가용성(HA)을 위해서는 Slave node가 필요 - 복제본 추가 시 모든 Master node에 각각 1개씩 Slave node가 할당됨 - <예시> 샤드 3개, 샤드당 복제본 1개인 경우 - Master node: 3대 - Slave node: 3대 - 샤드당 복제본을 `0`으로 설정하면 고가용성 지원이 되지 않음 - `CloudRedisModeCode`가 `CLUSTER`인 경우에만 입력 - `CloudRedisModeCode`가 `SIMPLE`이면 `shardCopyCount`가 입력되어도 무시함 |
| `isHa` | Boolean | Optional | 고가용성 여부 - `true` \| `false` (기본값) - 고가용성 선택 시, Standby Master 서버를 이용한 자동 장애 복구를 지원하며, 추가 요금 발생 및 자동으로 백업이 설정됨 |
| `configGroupNo` | String | Required | Config Group 번호 - [getCloudCacheConfigGroupList](/docs/database-vcache-getcloudcacheconfiggrouplist) 참조 - Redis Server 설정을 효율적으로 관리하기 위한 Config Group을 제공하며, 하나의 클러스터군은 모두 같은 config를 사용하게 됨 - Config Group이 없는 경우, 새로 생성해야 하며 생성 후에도 온라인으로 변경 가능 - Redis Server의 타입(Cluster/Simple) 및 Redis 엔진 버전 정보와 일치하는 Config Group 번호를 입력해야 함 - <예시>Redis Server의 타입이 'Cluster'이고, Redis 엔진 버전이 '7.0.15'인 경우 `cloudRedisVersion`이 `7.0.15-cluster`에 해당하는 `configGroupNo` 값을 입력 |
| `isBackup` | Boolean | Optional | Redis의 백업 설정 여부 - `true` \| `false`(기본값) - 고가용성 여부(`isHa`)가 `true`일 경우 백업 여부(isBackup)는 `true`로 고정됨 |
| `backupFileRetentionPeriod` | Integer | Optional | 백업 파일 보관 기간(일) - 1~7 (기본값: 1) - 백업은 매일 수행되며, 백업 파일은 별도의 백업 스토리지에 저장됨 - 요금은 사용하는 공간만큼만 과금됨 |
| `backupTime` | String | Conditional | 백업 시점 설정 - `true` (기본값) \| `false` - 백업 여부(`isBackup`)가 `true`, 자동 백업 여부(`isAutomaticBackup`)가 `false`인 경우 필수 입력 - <예시>01:15 (선택한 시간 + 15분 사이에 Backup이 시작) |
| `isAutomaticBackup` | Boolean | Optional | 백업 시점 자동 설정 여부 - `true` (기본값) \| `false` - 설정 값이 `true`인 경우, `backupTime`가 입력되어도 무시하며 자동으로 설정됨 |
| `cloudRedisServiceName` | String | Required | 생성할 Cloud DB for Cache 서비스 이름 - 영문자, 숫자, 한글, 특수 문자 '-'를 조합하여 3~15자 이내로 입력 - Redis 서비스 이름은 중복으로 사용 불가 |
| `cloudRedisServerNamePrefix` | String | Required | 생성할 Cloud DB for Cache 서버 이름 접두사 - 영문 소문자, 숫자, 특수 문자 '-'를 조합하여 3~15자 이내로 입력 - 문자열은 영문자로 시작해서 영문자 또는 숫자로 끝나야 함 - 접두사 뒤에 3자리 숫자가 자동으로 생성됨 - Redis 서버 이름은 중복으로 사용 불가 |
| `cloudRedisPort` | Integer | Optional | Cloud DB for Cache 인스턴스에 접근하기 위한 TCP 포트 번호 - 6379 (기본값) - 지정 범위: 10000~20000 |
| `subnetNo` | String | Required | 생성할 Cloud Redis 인스턴스의 Subnet 번호 - [getCloudCacheTargetSubnetList](/docs/database-vcache-getcloudcachetargetsubnetlist) 액션을 통해서 확인 - Private Subnet에서만 생성 가능 - Cloud DB for Cache 인스턴스 생성 이후에 Subnet 이전 불가능 |
| `engineVersionCode` | String | Conditional | Redis 엔진 버전 - [getCloudCacheImageProductList](/docs/database-vcache-getcloudcacheimageproductlist) 참조 - 미입력 시 현재 제공 중인 최신 버전으로 생성 |
| `cloudRedisModeCode` | String | Required | 생성할 Cloud DB for Cache 모드 - `CLUSTER` \| `SIMPLE` - `CLUSTER`: Master, Slave 방식을 사용하며 데이터 샤딩으로 트래픽 분산이 가능한 Redis - `SIMPLE`: Master, Standby-Master 방식을 사용하는 기본 Redis - `CLUSTER` 설정 사용 시, 고가용성 여부(`isHa`)가 입력되어도 무시함 |
| `responseFormatType` | String | Optional | 응답 결과의 형식 - `xml` (기본값) \| `json` |
| `generationCode` | String | Optional | 서버 세대 - G2 - G3 |
#### 요청 예시
요청 예시는 다음과 같습니다.
```
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}'
```
### 응답
응답 형식을 설명합니다.
#### 응답 바디
응답 바디는 [CloudRedisInstanceList](/docs/common-vapidatatype-cloudRedisinstancelist)를 참조해 주십시오.
#### 응답 상태 코드
Cloud DB for Cache (VPC) API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Cloud DB for Cache (VPC) 응답 상태 코드](/docs/database-vcache#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오.
#### 응답 예시
응답 예시는 다음과 같습니다.
- `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"
}
}
```
- `responseFormatType=xml` (기본값) 일 때
```
6aaac383-****-****-****-e7b07eea5c35
0
success
1
****511
test-****
creating
INIT
CLOUD DATABASE(VPC) Init State
CREAT
CLOUD DATABASE(VPC) Creat OP
SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050
REDIS 7.0.15
BSD
Berkeley Software Distribution
6379
true
test-****
G2
CLUSTER
CLOUD REDIS(VPC) Cluster Role
2024-07-01T16:59:21+0900
3
3
***9
test-***-config
test-****-001-001-ehd
M
Master
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
redisc-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
test-****-002-001-ehe
M
Master
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
redisc-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
test-****-003-001-ehf
M
Master
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
redisc-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
test-****-001-002-ehg
S
Slave
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
redisc-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
test-****-002-002-ehh
S
Slave
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
redisc-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
test-****-003-002-ehi
S
Slave
creating
PEND
CLOUD DATABASE(VPC) Server Pending State
CREAT
CLOUD DATABASE(VPC) Server Create OP
SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
KR
****83
****92
redisc-*****-vpc-cdb.ntruss.com
4
1610612736
2147483648
2024-07-01T16:59:21+0900
```