---
title: "getCloudCacheInstanceList"
slug: "database-vcache-getcloudcacheinstancelist"
tags: ["Cloud DB for Cache"]
updated: 2026-10-22T10:47:15Z
published: 2026-10-22T10:47:15Z
canonical: "api-gov.ncloud-docs.com/database-vcache-getcloudcacheinstancelist"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://api-gov.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.
# getCloudCacheInstanceList
VPC 환경에서 이용 가능합니다.
Cloud DB for Cache 인스턴스 리스트를 조회합니다.
참고
Cloud DB for Cache API는 지원하는 DBMS 범위에 따라 두 가지 버전을 제공합니다.
- getCloudCacheInstanceList API: Valkey, Redis DBMS 이용 가능
- getCloudRedisInstanceList API: Redis DBMS 이용 가능
## getCloudCacheInstanceList API
getCloudCacheInstanceList API의 요청, 응답 형식을 설명합니다.
### 요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
| --- | --- |
| GET \| POST | /vcache/v2/getCloudCacheInstanceList |
#### 요청 헤더
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` 조회 결과의 첫 번째 리전(기본값) |
| `zoneCode` | String | Optional | 존 코드로 필터링 - [getZoneList](/docs/compute-vserver-server-common-getzonelist) 참조 |
| `vpcNo` | String | Optional | VPC 번호로 필터링 - [getCloudCacheTargetVpcList](/docs/database-vcache-getcloudcachetargetvpclist) 참조 |
| `subnetNo` | String | Optional | Subnet 번호로 필터링 - [getCloudCacheTargetSubnetList](/docs/database-vcache-getcloudcachetargetsubnetlist) 참조 |
| `cloudCacheServiceName` | String | Optional | Cloud DB for Cache 서비스 이름으로 필터링 |
| `cloudCacheInstanceNoList.N` | List[String] | Optional | Cloud DB for Cache 인스턴스 번호 리스트 - Cloud DB for Cache 인스턴스 번호로 필터링 - [getCloudCacheInstanceList](/docs/database-vcache-getcloudcacheinstancelist) 참조 - <예시> `cloudCacheInstanceNoList.1=1234&cloudCacheInstanceNoList.2=2345` |
| `cloudCacheServerName` | String | Optional | Cloud DB for Cache 서버 이름으로 필터링 - [getCloudCacheInstanceList](/docs/database-vcache-getcloudcacheinstancelist) 참조 |
| `cloudCacheServerInstanceNoList.N` | List[String] | Optional | Cloud DB for Cache 서버 인스턴스 번호 리스트 - Cloud DB for Cache 서버 인스턴스 번호로 필터링 - [getCloudCacheInstanceList](/docs/database-vcache-getcloudcacheinstancelist) 참조 - <예시> `cloudCacheServerInstanceNoList.1=1234&cloudCacheServerInstanceNoList.2=2345` |
| `generationCode` | String | Optional | 서버 세대 코드로 필터링 - `G2` \| `G3` |
| `pageNo` | Integer | Optional | 페이징 처리된 결과의 페이지 번호 - `pageNo`, `pageSize`를 이용하여 페이징 처리 - 0 (최소) |
| `pageSize` | Integer | Conditional | 한 페이지에 보여줄 결과 개수 - `pageNo`, `pageSize`를 이용하여 페이징 처리 - `pageNo` 입력 시 필수 입력 - 1 (최소) |
| `cloudCacheDbmsCode` | String | Optional | Cloud DB for Cache 인스턴스의 DBMS 코드 - `Redis` \| `Valkey` |
| `responseFormatType` | String | Optional | 응답 결과의 형식 - `xml` (기본값) \| `json` |
#### 요청 예시
요청 예시는 다음과 같습니다.
```
curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/vcache/v2/getCloudCacheInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=****83
&subnetNo=****91
&cloudCacheServiceName=test-****
&cloudCacheInstanceNoList.1=****511
&cloudCacheServerName=test-****
&cloudCacheServerInstanceNoList.1=****613
&generationCode=G2
&pageNo=0
&pageSize=10' \
--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)를 참조해 주십시오.
#### 응답 상태 코드
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Ncloud API 응답 상태 코드](/docs/api-call-lgc-errorhandling)를 참조해 주십시오.
#### 응답 예시
응답 예시는 다음과 같습니다.
- `responseFormatType=json` 일 때
```
{
"getCloudCacheInstanceListResponse": {
"totalRows": 1,
"cloudCacheInstanceList": [
{
"cloudCacheInstanceNo": "****511",
"cloudCacheServiceName": "test-****",
"cloudCacheInstanceStatusName": "running",
"cloudCacheInstanceStatus": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Created 상태"
},
"cloudCacheInstanceOperation": {
"code": "NULL",
"codeName": "CLOUD DATABASE(VPC) Null OP"
},
"isHa": true,
"generationCode": "G2",
"role": {
"code": "SIMPLE",
"codeName": "CLOUD CACHE(VPC) Cluster Role"
},
"cloudCacheServerInstanceList": [
{
"cloudCacheServerInstanceNo": "****613",
"cloudCacheServerName": "test-****-001-001-ehs",
"cloudCacheServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudCacheServerInstanceStatusName": "running",
"cloudCacheServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudCacheServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
},
{
"cloudCacheServerInstanceNo": "****616",
"cloudCacheServerName": "test-****-002-001-eht",
"cloudCacheServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudCacheServerInstanceStatusName": "running",
"cloudCacheServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudCacheServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
},
{
"cloudCacheServerInstanceNo": "****619",
"cloudCacheServerName": "test-****-003-001-ehu",
"cloudCacheServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudCacheServerInstanceStatusName": "running",
"cloudCacheServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudCacheServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
},
{
"cloudCacheServerInstanceNo": "****622",
"cloudCacheServerName": "test-****-001-002-ehv",
"cloudCacheServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudCacheServerInstanceStatusName": "running",
"cloudCacheServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudCacheServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
},
{
"cloudCacheServerInstanceNo": "****625",
"cloudCacheServerName": "test-****-002-002-ehw",
"cloudCacheServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudCacheServerInstanceStatusName": "running",
"cloudCacheServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudCacheServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
},
{
"cloudCacheServerInstanceNo": "****628",
"cloudCacheServerName": "test-****-003-002-ehx",
"cloudCacheServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudCacheServerInstanceStatusName": "running",
"cloudCacheServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudCacheServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
}
]
}
],
"requestId": "02c8adab-****-****-****-6d6b37885670",
"returnCode": "0",
"returnMessage": "success"
}
}
```
- `responseFormatType=xml` (기본값) 일 때
```
02c8adab-****-****-****-6d6b37885670
0
success
1
****511
test-****
running
CREAT
CLOUD DATABASE(VPC) Created 상태
NULL
CLOUD DATABASE(VPC) Null OP
true
G2
SIMPLE
CLOUD CACHE(VPC) Cluster Role
****613
test-****-001-001-ehs
M
Master
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
****616
test-****-002-001-eht
M
Master
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
****619
test-****-003-001-ehu
M
Master
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
****622
test-****-001-002-ehv
S
Slave
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
****625
test-****-002-002-ehw
S
Slave
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
****628
test-****-003-002-ehx
S
Slave
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
```
## getCloudRedisInstanceList API
getCloudRedisInstanceList API의 요청, 응답 형식을 설명합니다.
### 요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
| --- | --- |
| GET \| POST | /vredis/v2/getCloudRedisInstanceList |
#### 요청 헤더
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` 조회 결과의 첫 번째 리전(기본값) |
| `zoneCode` | String | Optional | 존 코드로 필터링 - [getZoneList](/docs/compute-vserver-server-common-getzonelist) 참조 |
| `vpcNo` | String | Optional | VPC 번호로 필터링 - [getCloudCacheTargetVpcList](/docs/database-vcache-getcloudcachetargetvpclist) 참조 |
| `subnetNo` | String | Optional | Subnet 번호로 필터링 - [getCloudCacheTargetSubnetList](/docs/database-vcache-getcloudcachetargetsubnetlist) 참조 |
| `cloudRedisServiceName` | String | Optional | Cloud DB for Cache 서비스 이름으로 필터링 |
| `cloudRedisInstanceNoList.N` | List[String] | Optional | Cloud DB for Cache 인스턴스 번호 리스트 - Cloud DB for Cache 인스턴스 번호로 필터링 - [getCloudCacheInstanceList](/docs/database-vcache-getcloudcacheinstancelist) 참조 - <예시> `cloudRedisInstanceNoList.1=1234&cloudRedisInstanceNoList.2=2345` |
| `cloudRedisServerName` | String | Optional | Cloud DB for Cache 서버 이름으로 필터링 - [getCloudCacheInstanceList](/docs/database-vcache-getcloudcacheinstancelist) 참조 |
| `cloudRedisServerInstanceNoList.N` | List[String] | Optional | Cloud DB for Cache 서버 인스턴스 번호 리스트 - Cloud DB for Cache 서버 인스턴스 번호로 필터링 - [getCloudCacheInstanceList](/docs/database-vcache-getcloudcacheinstancelist) 참조 - <예시> `cloudRedisServerInstanceNoList.1=1234&cloudRedisServerInstanceNoList.2=2345` |
| `generationCode` | String | Optional | 서버 세대 코드로 필터링 - `G2` \| `G3` |
| `pageNo` | Integer | Optional | 페이징 처리된 결과의 페이지 번호 - `pageNo`, `pageSize`를 이용하여 페이징 처리 - 0 (최소) |
| `pageSize` | Integer | Conditional | 한 페이지에 보여줄 결과 개수 - `pageNo`, `pageSize`를 이용하여 페이징 처리 - `pageNo` 입력 시 필수 입력 - 1 (최소) |
| `responseFormatType` | String | Optional | 응답 결과의 형식 - `xml` (기본값) \| `json` |
#### 요청 예시
요청 예시는 다음과 같습니다.
```
curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/vredis/v2/getCloudRedisInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=****83
&subnetNo=****91
&cloudRedisServiceName=test-****
&cloudRedisInstanceNoList.1=****511
&cloudRedisServerName=test-****
&cloudRedisServerInstanceNoList.1=****613
&generationCode=G2
&pageNo=0
&pageSize=10' \
--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)를 참조해 주십시오.
#### 응답 상태 코드
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Ncloud API 응답 상태 코드](/docs/api-call-lgc-errorhandling)를 참조해 주십시오.
#### 응답 예시
응답 예시는 다음과 같습니다.
- `responseFormatType=json` 일 때
```
{
"getCloudRedisInstanceListResponse": {
"totalRows": 1,
"cloudRedisInstanceList": [
{
"cloudRedisInstanceNo": "****511",
"cloudRedisServiceName": "test-****",
"cloudRedisInstanceStatusName": "running",
"cloudRedisInstanceStatus": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Created 상태"
},
"cloudRedisInstanceOperation": {
"code": "NULL",
"codeName": "CLOUD DATABASE(VPC) Null OP"
},
"isHa": true,
"generationCode": "G2",
"role": {
"code": "SIMPLE",
"codeName": "CLOUD REDIS(VPC) Cluster Role"
},
"cloudRedisServerInstanceList": [
{
"cloudRedisServerInstanceNo": "****613",
"cloudRedisServerName": "test-****-001-001-ehs",
"cloudRedisServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
},
{
"cloudRedisServerInstanceNo": "****616",
"cloudRedisServerName": "test-****-002-001-eht",
"cloudRedisServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
},
{
"cloudRedisServerInstanceNo": "****619",
"cloudRedisServerName": "test-****-003-001-ehu",
"cloudRedisServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
},
{
"cloudRedisServerInstanceNo": "****622",
"cloudRedisServerName": "test-****-001-002-ehv",
"cloudRedisServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
},
{
"cloudRedisServerInstanceNo": "****625",
"cloudRedisServerName": "test-****-002-002-ehw",
"cloudRedisServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
},
{
"cloudRedisServerInstanceNo": "****628",
"cloudRedisServerName": "test-****-003-002-ehx",
"cloudRedisServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"cpuCount": 4,
"memorySize": 1610612736
}
]
}
],
"requestId": "02c8adab-****-****-****-6d6b37885670",
"returnCode": "0",
"returnMessage": "success"
}
}
```
- `responseFormatType=xml` (기본값) 일 때
```
02c8adab-****-****-****-6d6b37885670
0
success
1
****511
test-****
running
CREAT
CLOUD DATABASE(VPC) Created 상태
NULL
CLOUD DATABASE(VPC) Null OP
true
G2
SIMPLE
CLOUD REDIS(VPC) Cluster Role
****613
test-****-001-001-ehs
M
Master
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
****616
test-****-002-001-eht
M
Master
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
****619
test-****-003-001-ehu
M
Master
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
****622
test-****-001-002-ehv
S
Slave
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
****625
test-****-002-002-ehw
S
Slave
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
****628
test-****-003-002-ehx
S
Slave
running
RUN
CLOUD DATABASE(VPC) 서버 Running 상태
NOOP
CLOUD DATABASE(VPC) 서버 Null OP
KR
KR-1
****83
****92
4
1610612736
```