getCloudCacheConfigGroupList

VPC 환경에서 이용 가능합니다.

Cloud DB for Cache Config Group 리스트를 조회합니다.

참고

Cloud DB for Cache API는 지원하는 DBMS 범위에 따라 두 가지 버전을 제공합니다.

getCloudCacheConfigGroupList API: Valkey, Redis DBMS 이용 가능
getCloudRedisConfigGroupList API: Redis DBMS 이용 가능

getCloudCacheConfigGroupList API

getCloudCacheConfigGroupList API의 요청, 응답 형식을 설명합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET, POST	/getCloudCacheConfigGroupList

요청 헤더

Cloud DB for Cache (VPC) API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud DB for Cache (VPC) 요청 헤더를 참조해 주십시오.

요청 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`regionCode`	String	Optional	조회할 Cloud DB for Cache Config Group 리스트의 리전 코드 getRegionList를 통해 확인 `getRegionList` 조회 결과의 첫 번째 리전(기본값)
`cloudCacheInstanceNo`	String	Optional	Cloud DB for Cache 인스턴스 번호로 필터링 getCloudCacheInstanceList를 통해 확인
`cloudCacheServiceName`	String	Optional	Cloud DB for Cache 인스턴스 이름으로 필터링 getCloudCacheInstanceList를 통해 확인
`configGroupNo`	String	Optional	Config Group 번호로 필터링 getCloudCacheConfigGroupList를 통해 확인
`configGroupName`	String	Optional	Config Group 이름으로 필터링 getCloudCacheConfigGroupList를 통해 확인
`cloudCacheImageProductCode`	String	Optional	조회할 Config Group의 버전에 해당하는 Cloud Cache 이미지 상품 코드로 필터링 getCloudCacheImageProductList를 통해 확인
`cloudCacheModeCode`	String	Optional	Cloud DB for Cache 구성Cloud DB for Cache의 구성 유형으로 필터링 `SIMPLE` getCloudCacheInstanceList를 통해 확인
`cloudCacheDbmsCode`	String	Optional	Cloud DB for Cache 인스턴스의 DBMS 코드 `Redis` \| `Valkey`
`responseFormatType`	String	Optional	응답 결과의 형식 `xml` (기본값) \| `json`

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.gov-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를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

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",
                "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>
            <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의 요청, 응답 형식을 설명합니다.

요청