getCloudRedisConfigGroupList

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

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

요청

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

메서드	URI
GET, POST	/getCloudRedisConfigGroupList

요청 헤더

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

요청 파라미터

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

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

요청 예시

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

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

응답 상태 코드

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

응답 예시

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

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>