getCloudCacheConfigGroupList

Prev Next

Available in VPC

Overview

Get the Cloud DB for Cache config group list.

Note

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

  • getCloudCacheConfigGroupList CLI: Support for Valkey and Redis DBMS
  • getCloudRedisConfigGroupList CLI: Support for Redis DBMS

getCloudCacheConfigGroupList CLI

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

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String - Region code
Determine the Region in which the Cloud DB for Cache config group list will be queried.
regionCode can be obtained through the getRegionList action.
Default: Select the first Region of the getRegionList search results.
cloudCacheInstanceNo No String - Cloud DB for Cache instance number to which the config group to be queried is applied
cloudCacheInstanceNo can be obtained through the getCloudCacheInstanceList action.
cloudCacheServiceName No String - Cloud DB for Cache instance name to which the config group to be queried is applied
cloudCacheServiceName can be obtained through the getCloudCacheInstanceList action.
configGroupNo No String - Config group number to query
configGroupNo can be obtained through the getCloudCacheConfigGroupList action.
configGroupName No String - Config group name to query
configGroupName can be obtained through the getCloudCacheConfigGroupList action.
cloudCacheModeCode No String - Cloud DB for Cache configuration
Cloud DB for Cache configuration to which the config group to be queried is applied
cloudCacheModeCode can be obtained through the getCloudCacheInstanceList action.
Options : SIMPLE | CLUSTER
cloudCacheDbmsCode String Optional Cloud DB for Cache instance's DBMS code
Options: Redis | Valkey
output No String - Format type of the response result
Options: xml | json
Default: json

Response

Response data type

  • CloudCacheConfigGroupList type
CloudCacheConfigGroupList extends CommonResponse
private Integer totalRows;
private List<CloudCacheConfigGroup> cloudCacheConfigGroupList = new ArrayList<>();
CloudCacheConfigGroup
private String configGroupNo;
private String configGroupName;
private String configGroupDescription;
private String configGroupStatusName;
private CommonCode configGroupStatus;
private String cloudCacheVersion;
private String cloudCacheDbmsCode;
private Date createDate;
private Date modifyDate;
private CloudCacheInstanceNoList cloudCacheInstanceNoList;
CloudCacheInstanceNoList
private List<String> cloudCacheInstanceNoList = new ArrayList<>();

Examples

Call

ncloud vcache getCloudCacheConfigGroupList --regionCode KR --cloudCacheInstanceNo ****821 --cloudCacheServiceName ***test --configGroupNo ***9 --configGroupName test-****-config --cloudCacheModeCode SIMPLE

Response


<getCloudCacheConfigGroupListResponse>
    <requestId>06a7bbf2-a576-4521-bdf4-392711e31560</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheConfigGroupList>
        <cloudCacheConfigGroup>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>exercise</configGroupName>
            <configGroupDescription>description</configGroupDescription>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <cloudCacheVersion>7.2.11-simple</cloudCacheVersion>
            <cloudCacheDbmsCode>Valkey</cloudCacheDbmsCode>
            <createDate>2020-11-26T13:47:27+0900</createDate>
            <modifyDate>2020-11-26T13:47:27+0900</modifyDate>
            <cloudCacheInstanceNoList>
                <cloudCacheInstanceNo>****821</cloudCacheInstanceNo>
            </cloudCacheInstanceNoList>
        </cloudCacheConfigGroup>
    </cloudCacheConfigGroupList>
</getCloudCacheConfigGroupListResponse>

getCloudRedisConfigGroupList CLI

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

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String - Region code
Determine the Region in which the Cloud DB for Cache config group list will be queried.
regionCode can be obtained through the getRegionList action.
Default: Select the first Region of the getRegionList search results.
cloudRedisInstanceNo No String - Cloud DB for Cache instance number to which the config group to be queried is applied
cloudRedisInstanceNo can be obtained through the getCloudCacheInstanceList action.
cloudRedisServiceName No String - Cloud DB for Cache instance name to which the config group to be queried is applied
cloudRedisServiceName can be obtained through the getCloudCacheInstanceList action.
configGroupNo No String - Config group number to query
configGroupNo can be obtained through the getCloudCacheConfigGroupList action.
configGroupName No String - Config group name to query
configGroupName can be obtained through the getCloudCacheConfigGroupList action.
cloudRedisModeCode No String - Cloud DB for Cache configuration
Cloud DB for Cache configuration to which the config group to be queried is applied
CLUSTER, SIMPLE
cloudRedisModeCode can be obtained through the getCloudCacheInstanceList action.
output No String - Format type of the response result
Options: xml | json
Default: json

Response

Response data type

  • CloudRedisConfigGroupList type
CloudRedisConfigGroupList extends CommonResponse
private Integer totalRows;
private List<CloudRedisConfigGroup> cloudRedisConfigGroupList = new ArrayList<>();
CloudRedisConfigGroup
private String configGroupNo;
private String configGroupName;
private String configGroupDescription;
private String configGroupStatusName;
private CommonCode configGroupStatus;
private String cloudRedisVersion;
private Date createDate;
private Date modifyDate;
private CloudRedisInstanceNoList cloudRedisInstanceNoList;
CloudRedisInstanceNoList
private List<String> cloudRedisInstanceNoList = new ArrayList<>();

Examples

Call

ncloud vredis getCloudRedisConfigGroupList --regionCode KR --cloudRedisInstanceNo ****821 --cloudRedisServiceName ***test --configGroupNo ***9 --configGroupName test-****-config --cloudRedisModeCode CLUSTER

Response



<getCloudRedisConfigGroupListResponse>
    <requestId>96bceb85-b1b8-4c6c-bacb-7207a1890af8</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisConfigGroupList>
        <cloudRedisConfigGroup>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>exercise</configGroupName>
            <configGroupDescription>practice</configGroupDescription>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <cloudRedisVersion>4.0.14-cluster</cloudRedisVersion>
            <createDate>2020-11-26T13:47:27+0900</createDate>
            <modifyDate>2020-11-26T13:47:27+0900</modifyDate>
            <cloudRedisInstanceNoList>
                <cloudRedisInstanceNo>****821</cloudRedisInstanceNo>
            </cloudRedisInstanceNoList>
        </cloudRedisConfigGroup>
    </cloudRedisConfigGroupList>
</getCloudRedisConfigGroupListResponse>