VPC 환경에서 이용 가능
개요
Cloud DB for Cache Config group 리스트를 조회합니다.
참고
Cloud DB for Cache CLI는 지원하는 DBMS 범위에 따라 두 가지 버전을 제공합니다.
- getCloudCacheConfigGroupList CLI: Valkey, Redis DBMS 이용 가능
- getCloudRedisConfigGroupList CLI: Redis DBMS 이용 가능
getCloudCacheConfigGroupList CLI
getCloudCacheConfigGroupList CLI의 요청, 응답 형식을 설명합니다.
요청
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| regionCode | No | String | - 리전 코드 Cloud DB for Cache Config Group 리스트가 조회될 리전(Region)을 결정 가능 regionCode는 getRegionList 액션을 통해서 획득 가능 Default: getRegionList 조회 결과의 첫 번째 리전 선택 |
|
| cloudCacheInstanceNo | No | String | - 조회할 ConfigGroup이 적용된 Cloud DB for Cache 인스턴스 번호 cloudCacheInstanceNo는 getCloudCacheInstanceList 액션을 통해서 획득 가능 |
|
| cloudCacheServiceName | No | String | - 조회할 ConfigGroup이 적용된 Cloud DB for Cache 서비스 이름 cloudCacheServiceName는 getCloudCacheInstanceList 액션을 통해서 획득 가능 |
|
| configGroupNo | No | String | - 조회할 ConfigGroup 번호 configGroupNo는 getCloudCacheConfigGroupList 액션을 통해서 획득 가능 |
|
| configGroupName | No | String | - 조회할 ConfigGroup 이름 configGroupName는 getCloudCacheConfigGroupList 액션을 통해서 획득 가능 |
|
| cloudCacheModeCode | No | String | - Cloud DB for Cache 구성 조회할 ConfigGroup이 적용된 Cloud DB for Cache의 구성. cloudCacheModeCode는 getCloudCacheInstanceList 액션을 통해서 획득 가능 Options : SIMPLE | CLUSTER |
|
| cloudCacheDbmsCode | String | Optional | Cloud DB for Cache 인스턴스의 DBMS 코드 Options: Redis | Valkey |
|
| output | No | String | - 응답 결과의 포맷 타입 Options: xml | json Default: json |
응답
응답 데이터 타입
- CloudCacheConfigGroupList 타입
| 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<>(); |
예시
호출
ncloud vcache getCloudCacheConfigGroupList --regionCode KR --cloudCacheInstanceNo ****821 --cloudCacheServiceName ***test --configGroupNo ***9 --configGroupName test-****-config --cloudCacheModeCode SIMPLE
응답
<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
getCloudRedisConfigGroupList CLI의 요청, 응답 형식을 설명합니다.
요청
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| regionCode | No | String | - 리전 코드 Cloud DB for Cache Config Group 리스트가 조회될 리전(Region) 결정 가능 regionCode는 getRegionList 액션을 통해서 획득 가능 Default: getRegionList 조회 결과의 첫 번째 리전을 선택 |
|
| cloudRedisInstanceNo | No | String | - 조회할 ConfigGroup이 적용된 Cloud DB for Cache 인스턴스 번호 cloudRedisInstanceNo는 getCloudCacheInstanceList 액션을 통해서 획득 가능 |
|
| cloudRedisServiceName | No | String | - 조회할 ConfigGroup이 적용된 Cloud DB for Cache 인스턴스 이름 cloudRedisServiceName는 getCloudCacheInstanceList 액션을 통해서 획득 가능 |
|
| configGroupNo | No | String | - 조회할 ConfigGroup 번호 configGroupNo는 getCloudCacheConfigGroupList 액션을 통해서 획득 가능 |
|
| configGroupName | No | String | - 조회할 ConfigGroup 이름 configGroupName는 getCloudCacheConfigGroupList 액션을 통해서 획득 가능 |
|
| cloudRedisModeCode | No | String | - Cloud DB for Cache 구성 조회할 ConfigGroup이 적용된 Cloud DB for Cache의 구성 CLUSTER, SIMPLE cloudRedisModeCode는 getCloudCacheInstanceList 액션을 통해서 획득 가능 |
|
| output | No | String | - 응답 결과의 포맷 타입 Options: xml | json Default: json |
응답
응답 데이터 타입
- CloudRedisConfigGroupList 타입
| 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<>(); |
예시
호출
ncloud vredis getCloudRedisConfigGroupList --regionCode KR --cloudRedisInstanceNo ****821 --cloudRedisServiceName ***test --configGroupNo ***9 --configGroupName test-****-config --cloudRedisModeCode CLUSTER
응답
<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>