---
title: "createCloudCacheInstance"
slug: "database-vcache-createcloudcacheinstance"
tags: ["Cloud DB for Cache"]
updated: 2026-09-17T09:57:47Z
published: 2026-09-17T09:57:47Z
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の範囲に応じて2つのバージョンを提供しています。
- createCloudCacheInstance API: Valkey、Redis DBMSを利用可能
- createCloudRedisInstance API: Redis DBMSを利用可能
## createCloudCacheInstance API
createCloudCacheInstance APIのリクエストおよび レスポンス形式を説明します。
### リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
| --- | --- |
| GET \| POST | /vcache/v2/createCloudCacheInstance |
参考
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
### リクエストヘッダ
Cloud DB for Cache (VPC) APIで共通して使用されるヘッダの詳細は、[Cloud DB for Cache (VPC)のリクエストヘッダ](/docs/ja/database-vcache#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。
#### リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 作成する Cloud DB for Cacheインスタンスのリージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - `getRegionList`照会結果の最初のリージョン(デフォルト) |
| `vpcNo` | String | Required | Cloud DB for Cacheインスタンスを作成する VPC番号 - [getCloudCacheTargetVpcList](/docs/ja/database-vcache-getcloudcachetargetvpclist)を参照 |
| `cloudCacheImageProductCode` | String | Optional | Cloud DB for Cacheイメージ商品コード - [getCloudCacheImageProductList](/docs/ja/database-vcache-getcloudcacheimageproductlist)を参照 - NAVERクラウドプラットフォームで自動作成(デフォルト) |
| `cloudCacheProductCode` | String | Optional | Cloud DB for Cache商品コード - [getCloudCacheProductList](/docs/ja/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に Slave nodeが1つずつ割り当てられる - <例> シャード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/ja/database-vcache-getcloudcacheconfiggrouplist)を参照 - DB Serve設定を効率的に管理するための Config Groupを提供し、1つのクラスタ群はすべて同じ 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/ja/database-vcache-getcloudcachetargetsubnetlist)アクションを通じて確認 - Private Subnetでのみ作成可能 - Cloud DB for Cacheインスタンス作成後に Subnetの移転はできない |
| `engineVersionCode` | String | Conditional | Cacheエンジンのバージョン - [getCloudCacheImageProductList](/docs/ja/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/ja/common-vapidatatype-cloudcacheinstancelist)をご参照ください。
#### レスポンスステータスコード
Cloud DB for Cache (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud DB for Cache (VPC)のレスポンスステータスコード](/docs/ja/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メソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
### リクエストヘッダ
Cloud DB for Cache APIで共通して使用されるヘッダの詳細は、[Cloud DB for Cacheのリクエストヘッダ](/docs/ja/database-vcache#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。
#### リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 作成する Cloud DB for Cacheインスタンスのリージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - `getRegionList`照会結果の最初のリージョン(デフォルト) |
| `vpcNo` | String | Required | Cloud DB for Cacheインスタンスを作成する VPC番号 - [getCloudCacheTargetVpcList](/docs/ja/database-vcache-getcloudcachetargetvpclist)を参照 |
| `cloudRedisImageProductCode` | String | Optional | Cloud DB for Cacheイメージ商品コード - [getCloudCacheImageProductList](/docs/ja/database-vcache-getcloudcacheimageproductlist)を参照 - NAVERクラウドプラットフォームで自動作成(デフォルト) |
| `cloudRedisProductCode` | String | Optional | Cloud DB for Cache商品コード - [getCloudCacheProductList](/docs/ja/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に Slave nodeが1つずつ割り当てられる - <例> シャード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/ja/database-vcache-getcloudcacheconfiggrouplist)を参照 - Redis Server設定を効率的に管理するための Config Groupを提供し、1つのクラスタ群はすべて同じ 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/ja/database-vcache-getcloudcachetargetsubnetlist)アクションを通じて確認 - Private Subnetでのみ作成可能 - Cloud DB for Cacheインスタンス作成後に Subnetの移転はできない |
| `engineVersionCode` | String | Conditional | Redisエンジンのバージョン - [getCloudCacheImageProductList](/docs/ja/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/ja/common-vapidatatype-cloudRedisinstancelist)をご参照ください。
#### レスポンスステータスコード
Cloud DB for Cache (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud DB for Cache (VPC)のレスポンスステータスコード](/docs/ja/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
```