--- title: "getCloudCacheInstanceList" slug: "database-vcache-getcloudcacheinstancelist" tags: ["Cloud DB for Cache"] updated: 2026-09-17T09:57:47Z published: 2026-09-17T09:57:47Z canonical: "api.ncloud-docs.com/database-vcache-getcloudcacheinstancelist" --- > ## 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. # getCloudCacheInstanceList VPC環境で利用できます。 Cloud DB for Cacheインスタンスリストを照会します。 参考 Cloud DB for Cache APIは、対応する DBMSの範囲に応じて2つのバージョンを提供しています。 - getCloudCacheInstanceList API: Valkey、Redis DBMSを利用可能 - getCloudRedisInstanceList API: Redis DBMSを利用可能 ## getCloudCacheInstanceList API getCloudCacheInstanceList APIのリクエストおよびレスポンス形式を説明します。 ### リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | GET \| POST | /vcache/v2/getCloudCacheInstanceList | 参考 ガイドは 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`照会結果の最初のリージョン(デフォルト) | | `zoneCode` | String | Optional | ゾーンコードで絞り込み - [getZoneList](/docs/ja/compute-vserver-server-common-getzonelist)を参照 | | `vpcNo` | String | Optional | VPC番号で絞り込み - [getCloudCacheTargetVpcList](/docs/ja/database-vcache-getcloudcachetargetvpclist)を参照 | | `subnetNo` | String | Optional | Subnet番号で絞り込み - [getCloudCacheTargetSubnetList](/docs/ja/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/ja/database-vcache-getcloudcacheinstancelist)を参照 - <例> `cloudCacheInstanceNoList.1=1234&cloudCacheInstanceNoList.2=2345` | | `cloudCacheServerName` | String | Optional | Cloud DB for Cacheサーバ名で絞り込み - [getCloudCacheInstanceList](/docs/ja/database-vcache-getcloudcacheinstancelist)を参照 | | `cloudCacheServerInstanceNoList.N` | List[String] | Optional | Cloud DB for Cacheサーバインスタンス番号リスト - Cloud DB for Cacheサーバインスタンス番号で絞り込み - [getCloudCacheInstanceList](/docs/ja/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.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/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`の場合 ``` { "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 | 参考 ガイドは 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`照会結果の最初のリージョン(デフォルト) | | `zoneCode` | String | Optional | ゾーンコードで絞り込み - [getZoneList](/docs/ja/compute-vserver-server-common-getzonelist)を参照 | | `vpcNo` | String | Optional | VPC番号で絞り込み - [getCloudCacheTargetVpcList](/docs/ja/database-vcache-getcloudcachetargetvpclist)を参照 | | `subnetNo` | String | Optional | Subnet番号で絞り込み - [getCloudCacheTargetSubnetList](/docs/ja/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/ja/database-vcache-getcloudcacheinstancelist)を参照 - <例> `cloudRedisInstanceNoList.1=1234&cloudRedisInstanceNoList.2=2345` | | `cloudRedisServerName` | String | Optional | Cloud DB for Cacheサーバ名で絞り込み - [getCloudCacheInstanceList](/docs/ja/database-vcache-getcloudcacheinstancelist)を参照 | | `cloudRedisServerInstanceNoList.N` | List[String] | Optional | Cloud DB for Cacheサーバインスタンス番号リスト - Cloud DB for Cacheサーバインスタンス番号で絞り込み - [getCloudCacheInstanceList](/docs/ja/database-vcache-getcloudcacheinstancelist)を参照 - <例> `cloudRedisServerInstanceNoList.1=1234&cloudRedisServerInstanceNoList.2=2345` | | `generationCode` | String | Optional | サーバの世代コードで絞り込み - `G2` \| `G3` - [getCloudCacheInstanceList](/docs/ja/database-vcache-getcloudcacheinstancelist)を参照 | | `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.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/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`の場合 ``` { "getCloudRedisInstanceListResponse": { "totalRows": 1, "cloudRedisInstanceList": [ { "cloudRedisInstanceNo": "****511", "cloudRedisServiceName": "test-****", "cloudRedisInstanceStatusName": "running", "cloudRedisInstanceStatus": { "code": "CREAT", "codeName": "CLOUD DATABASE(VPC) Created State" }, "cloudRedisInstanceOperation": { "code": "NULL", "codeName": "CLOUD DATABASE(VPC) Null OP" }, "isHa": true, "generationCode": "G2", "role": { "code": "CLUSTER", "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) Server Running State" }, "cloudRedisServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server 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) Server Running State" }, "cloudRedisServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server 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) Server Running State" }, "cloudRedisServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server 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) Server Running State" }, "cloudRedisServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server 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) Server Running State" }, "cloudRedisServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server 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) Server Running State" }, "cloudRedisServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server 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 State NULL CLOUD DATABASE(VPC) Null OP true G2 CLUSTER CLOUD REDIS(VPC) Cluster Role ****613 test-****-001-001-ehs M Master running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP KR KR-1 ****83 ****92 4 1610612736 ****616 test-****-002-001-eht M Master running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP KR KR-1 ****83 ****92 4 1610612736 ****619 test-****-003-001-ehu M Master running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP KR KR-1 ****83 ****92 4 1610612736 ****622 test-****-001-002-ehv S Slave running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP KR KR-1 ****83 ****92 4 1610612736 ****625 test-****-002-002-ehw S Slave running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP KR KR-1 ****83 ****92 4 1610612736 ****628 test-****-003-002-ehx S Slave running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP KR KR-1 ****83 ****92 4 1610612736 ```