getCloudCacheConfigGroupList

Available in VPC

Get the Cloud DB for Cache config group list.

Note

Cloud DB for Cache API offers two versions based on the supported DBMS range.

getCloudCacheConfigGroupList API: Support for Valkey and Redis DBMS
getCloudRedisConfigGroupList API: Support for Redis DBMS

getCloudCacheConfigGroupList API

This section describes the request and response formats for the getCloudCacheConfigGroupList API.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET, POST	/getCloudCacheConfigGroupList

Request headers

For information about the headers common to all Cloud DB for Cache (VPC) APIs, see Cloud DB for Cache (VPC) request headers.

Request parameters

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code of the Cloud DB for Cache config group list to query See getRegionList. First Region of the `getRegionList` query result (default).
`cloudCacheInstanceNo`	String	Optional	Filter by Cloud DB for Cache instance number. See getCloudCacheInstanceList.
`cloudCacheServiceName`	String	Optional	Filter by Cloud DB for Cache instance name. See getCloudCacheInstanceList.
`configGroupNo`	String	Optional	Filter by config group number. See getCloudCacheConfigGroupList.
`configGroupName`	String	Optional	Filter by config group name. See getCloudCacheConfigGroupList.
`cloudCacheImageProductCode`	String	Optional	Filter by Cloud Cache image product code applicable for the config group version to query. See getCloudCacheImageProductList.
`cloudCacheModeCode`	String	Optional	Cloud DB for Cache configurationFilter by Cloud DB for Cache configuration type. `SIMPLE` \| `CLUSTER` See getCloudCacheInstanceList.
`cloudCacheDbmsCode`	String	Optional	Cloud DB for Cache instance's DBMS code `Redis` \| `Valkey`
`responseFormatType`	String	Optional	Format of the response result `xml` (default) \| `json`

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response body

See CloudCacheConfigGroupList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The response example is as follows:

If responseFormatType=json

{
    "getCloudCacheConfigGroupListResponse": {
        "totalRows": 1,
        "cloudCacheConfigGroupList": [
            {
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "configGroupDescription": "decription",
                "configGroupStatusName": "running",
                "configGroupStatus": {
                    "code": "RUN",
                    "codeName": "Config group Running status"
                },
                "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"
    }
}

If responseFormatType=xml (default)

<?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 status</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

This section describes the request and response formats for the getCloudRedisConfigGroupList API.