--- title: "CloudRedisInstance" slug: "common-vapidatatype-cloudredisinstance" tags: ["Cloud DB for Cache", "VPC"] updated: 2026-09-17T09:25:09Z published: 2026-09-17T09:25:09Z canonical: "api.ncloud-docs.com/common-vapidatatype-cloudredisinstance" --- > ## 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. # CloudRedisInstance Available in VPC This is a Cloud DB for Cache instance. ## Syntax The syntax is as follows. ``` private String cloudRedisInstanceNo; private String cloudRedisServiceName; private String cloudRedisInstanceStatusName; private CommonCode cloudRedisInstanceStatus; private CommonCode cloudRedisInstanceOperation; private String cloudRedisImageProductCode; private String engineVersion; private CommonCode licence; private Integer cloudRedisPort; private Boolean isHa; private String cloudRedisServerPrefix; private Boolean isBackup; private Integer backupFileRetentionPeriod; private String backupTime; private String backupSchedule; private Date createDate; private Integer shardCount; private Integer shardCopyCount; private AccessControlGroupNoList accessControlGroupNoList; private String configGroupNo; private String configGroupName; private CommonCode role; private List cloudRedisServerInstanceList; ``` ## Field The following describes the fields. | Field | Type | Required | Description | | --- | --- | --- | --- | | `cloudRedisInstanceNo` | String | Required | Cloud DB for Cache instance number | | `cloudRedisServiceName` | String | Required | Cloud DB for Cache service name | | `cloudRedisInstanceStatusName` | String | Required | Cloud DB for Cache instance status name - `creating` \| `deleted` \| `deleting` \| `downgrading` \| `pending` \| `recovering` \| `restarting` \| `running` \| `settingup` \| `shuttingdown` \| `stopped` \| `upgrading` | | `cloudRedisInstanceStatus` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Required | Cloud DB for Cache instance status - `INIT` \| `CREAT` \| `DEL` - `INIT`: initiated - `CREAT`: created - `DEL`: deleted | | `cloudRedisInstanceOperation` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Required | Cloud DB for Cache instance operation status - `CREAT` \| `DEL` \| `FO` \| `NULL` \| `SETUP` \| `UPGD` \| `DWGD` \| `BKP` - `CREAT`: create - `DEL`: delete - `FO`: failover - `NULL`: no operation - `SETUP`: setup - `UPGD`: upgrade - `DWGD`: downgrade - `BKP`: backup | | `cloudRedisImageProductCode` | String | Optional | Cloud DB for Cache image product code | | `engineVersion` | String | Optional | Cloud DB for Cache engine version | | `license` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Optional | Cloud DB for Cache license | | `cloudRedisPort` | Integer | Optional | Cloud DB for Cache port | | `isHa` | Boolean | Required | High availability status - `true` \| `false` | | `cloudRedisServerPrefix` | String | Optional | Cloud Redis server name prefix | | `isBackup` | Boolean | Optional | Backup status - `true` \| `false` | | `backupFileRetentionPeriod` | Integer | Optional | Backup file retention period | | `backupTime` | String | Optional | Backup time | | `backupSchedule` | String | Optional | Whether automatic backups are set up | | `createDate` | Date | Optional | Creation date and time | | `shardCount` | Integer | Optional | Number of shards for Cloud DB for Cache | | `shardCopyCount` | Integer | Optional | Replicas per Cloud DB for Cache shard | | `accessControlGroupNoList` | [AccessControlGroupNoList](/docs/en/common-vapidatatype-accesscontrolgroupnolist) | Optional | ACG number list | | `configGroupNo` | configGroupNo | Optional | Cloud DB for Cache config group number | | `configGroupName` | configGroupName | Optional | Cloud DB for Cache config group name | | `role` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Required | Configure Cloud DB for Cache | | `cloudRedisServerInstanceList` | List<[CloudRedisServerInstance](/docs/en/common-vapidatatype-cloudredisserverinstance)> | Required | Cloud DB for Cache server instance list |