---
title: "getCloudCacheConfigGroupList"
slug: "database-vcache-getcloudcacheconfiggrouplist"
tags: ["Cloud DB for Redis"]
updated: 2026-09-17T09:57:51Z
published: 2026-09-17T09:57:51Z
canonical: "api.ncloud-docs.com/database-vcache-getcloudcacheconfiggrouplist"
---

> ## 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.

# getCloudCacheConfigGroupList

VPC環境で利用できます。

Cloud DB for Cache Config Groupリストを照会します。

参考

Cloud DB for Cache APIは、対応する DBMSの範囲に応じて2つのバージョンを提供しています。

- getCloudCacheConfigGroupList API: Valkey、Redis DBMSを利用可能
- getCloudRedisConfigGroupList API: Redis DBMSを利用可能

## getCloudCacheConfigGroupList API

getCloudCacheConfigGroupList APIのリクエストおよびレスポンス形式を説明します。

### リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET \| POST | /vcache/v2/getCloudCacheConfigGroupList |

参考

ガイドは 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 Config Groupリストのリージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - `getRegionList`照会結果の最初のリージョン(デフォルト) |
| `cloudCacheInstanceNo` | String | Optional | Cloud DB for Cacheインスタンス番号で絞り込み - [getCloudCacheInstanceList](/docs/ja/database-vcache-getcloudcacheinstancelist)を参照 |
| `cloudCacheServiceName` | String | Optional | Cloud DB for Cacheインスタンス名で絞り込み - [getCloudCacheInstanceList](/docs/ja/database-vcache-getcloudcacheinstancelist)を参照 |
| `configGroupNo` | String | Optional | Config Group番号で絞り込み - [getCloudCacheConfigGroupList](/docs/ja/database-vcache-getcloudcacheconfiggrouplist)を参照 |
| `configGroupName` | String | Optional | Config Group名で絞り込み - [getCloudCacheConfigGroupList](/docs/ja/database-vcache-getcloudcacheconfiggrouplist)を参照 |
| `cloudCacheImageProductCode` | String | Optional | 照会対象 Config Groupのバージョンに対応する Cloud Cacheイメージ商品コードで絞り込み - [getCloudCacheImageProductList](/docs/ja/database-vcache-getcloudcacheimageproductlist)を参照 |
| `cloudCacheModeCode` | String | Optional | Cloud DB for Cacheの構成Cloud DB for Cacheの構成タイプで絞り込み - `SIMPLE` \| `CLUSTER` - [getCloudCacheInstanceList](/docs/ja/database-vcache-getcloudcacheinstancelist)を参照 |
| `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/getCloudCacheConfigGroupList
?regionCode=KR
&cloudCacheInstanceNo=****511
&cloudCacheServiceName=test-****
&configGroupNo=***9
&configGroupName=test-***-config
&cloudCacheImageProductCode=SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050
&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}'
```

### レスポンス

レスポンス形式を説明します。

#### レスポンスボディ

レスポンスボディの詳細は、[CloudCacheConfigGroupList](/docs/ja/common-vapidatatype-cloudcacheconfiggrouplist)をご参照ください。

#### レスポンスステータスコード

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`の場合

```
{
    "getCloudCacheConfigGroupListResponse": {
        "totalRows": 1,
        "cloudCacheConfigGroupList": [
            {
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "configGroupDescription": "decription",
                "configGroupStatusName": "running",
                "configGroupStatus": {
                    "code": "RUN",
                    "codeName": "CONFIG GROUP Running状態"
                },
                "cloudCacheVersion": "7.2.11-simple",
                "cloudCacheDbmsCode": "Redis",
                "createDate": "2024-07-01T16:36:38+0900",
                "modifyDate": "2024-07-01T16:36:40+0900",
                "cloudCacheInstanceNoList": [
                    "****511"
                ]
            }
        ],
        "requestId": "8d112bd6-****-****-****-ab3793ad0676",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
```

- `responseFormatType=xml`(デフォルト)の場合

```
<?xml version="1.0" encoding="UTF-8"?>
<getCloudCacheConfigGroupListResponse>
    <requestId>8d112bd6-****-****-****-ab3793ad0676</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheConfigGroupList>
        <cloudCacheConfigGroup>
            <configGroupNo>***9</configGroupNo>
            <configGroupName>test-***-config</configGroupName>
            <configGroupDescription>decription</configGroupDescription>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running状態</codeName>
            </configGroupStatus>
            <cloudCacheVersion>7.2.11-simple</cloudCacheVersion>
            <cloudCacheDbmsCode>Valkey</cloudCacheDbmsCode>
            <createDate>2024-07-01T16:36:38+0900</createDate>
            <modifyDate>2024-07-01T16:36:40+0900</modifyDate>
            <cloudCacheInstanceNoList>
                <cloudCacheInstanceNo>****511</cloudCacheInstanceNo>
            </cloudCacheInstanceNoList>
        </cloudCacheConfigGroup>
    </cloudCacheConfigGroupList>
</getCloudCacheConfigGroupListResponse>
```

## getCloudRedisConfigGroupList API

getCloudRedisConfigGroupList APIのリクエストおよびレスポンス形式を説明します。

### リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET \| POST | /vredis/v2/getCloudRedisConfigGroupList |

参考

ガイドは 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 Config Groupリストのリージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - `getRegionList`照会結果の最初のリージョン(デフォルト) |
| `cloudRedisInstanceNo` | String | Optional | Cloud DB for Cacheインスタンス番号で絞り込み - [getCloudCacheInstanceList](/docs/ja/database-vcache-getcloudcacheinstancelist)を参照 |
| `cloudRedisServiceName` | String | Optional | Cloud DB for Cacheインスタンス名で絞り込み - [getCloudCacheInstanceList](/docs/ja/database-vcache-getcloudcacheinstancelist)を参照 |
| `configGroupNo` | String | Optional | Config Group番号で絞り込み - [getCloudCacheConfigGroupList](/docs/ja/database-vcache-getcloudcacheconfiggrouplist)を参照 |
| `configGroupName` | String | Optional | Config Group名で絞り込み - [getCloudCacheConfigGroupList](/docs/ja/database-vcache-getcloudcacheconfiggrouplist)を参照 |
| `cloudRedisImageProductCode` | String | Optional | 照会対象 Config Groupのバージョンに対応する Cloud Redisイメージ商品コードで絞り込み - [getCloudCacheImageProductList](/docs/ja/database-vcache-getcloudcacheimageproductlist)を参照 |
| `cloudRedisModeCode` | String | Optional | Cloud DB for Cacheの構成Cloud DB for Cacheの構成タイプで絞り込み - `CLUSTER` \| `SIMPLE` - [getCloudCacheInstanceList](/docs/ja/database-vcache-getcloudcacheinstancelist)を参照 |
| `responseFormatType` | String | Optional | レスポンス結果の形式 - `xml`(デフォルト) \| `json` |

#### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisConfigGroupList
?regionCode=KR
&cloudRedisInstanceNo=****511
&cloudRedisServiceName=test-****
&configGroupNo=***9
&configGroupName=test-***-config
&cloudRedisImageProductCode=SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050
&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}'
```

### レスポンス

レスポンス形式を説明します。

#### レスポンスボディ

レスポンスボディの詳細は、[ConfigGroupList](/docs/ja/common-vapidatatype-cloudredisconfiggrouplist)をご参照ください。

#### レスポンスステータスコード

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`の場合

```
{
    "getCloudRedisConfigGroupListResponse": {
        "totalRows": 1,
        "cloudRedisConfigGroupList": [
            {
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "configGroupDescription": "decription",
                "configGroupStatusName": "running",
                "configGroupStatus": {
                    "code": "RUN",
                    "codeName": "CONFIG GROUP Running State"
                },
                "cloudRedisVersion": "7.0.15-cluster",
                "createDate": "2024-07-01T16:36:38+0900",
                "modifyDate": "2024-07-01T16:36:40+0900",
                "cloudRedisInstanceNoList": [
                    "****511"
                ]
            }
        ],
        "requestId": "8d112bd6-****-****-****-ab3793ad0676",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
```
- `responseFormatType=xml`(デフォルト)の場合

```
<?xml version="1.0" encoding="UTF-8"?>
<getCloudRedisConfigGroupListResponse>
    <requestId>8d112bd6-****-****-****-ab3793ad0676</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisConfigGroupList>
        <cloudRedisConfigGroup>
            <configGroupNo>***9</configGroupNo>
            <configGroupName>test-***-config</configGroupName>
            <configGroupDescription>decription</configGroupDescription>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <cloudRedisVersion>7.0.15-cluster</cloudRedisVersion>
            <createDate>2024-07-01T16:36:38+0900</createDate>
            <modifyDate>2024-07-01T16:36:40+0900</modifyDate>
            <cloudRedisInstanceNoList>
                <cloudRedisInstanceNo>****511</cloudRedisInstanceNo>
            </cloudRedisInstanceNoList>
        </cloudRedisConfigGroup>
    </cloudRedisConfigGroupList>
</getCloudRedisConfigGroupListResponse>
```