getCloudRedisConfigGroupList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Get a list of Cloud DB for Redis config groups.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET, POST	/getCloudRedisConfigGroupList

Request headers

For headers common to Cloud DB for Redis APIs, see Cloud DB for Redis request headers.

Request parameter

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code of the Cloud DB for Redis config group list to view Check through getRegionList First Region of the `getRegionList` query result (default)
`cloudRedisInstanceNo`	String	Optional	Filter by Cloud DB for Redis instance number Check through getCloudRedisInstanceList
`cloudRedisServiceName`	String	Optional	Filter by Cloud DB for Redis instance name Check through getCloudRedisInstanceList
`configGroupNo`	String	Optional	Filter by config group number Check through getCloudRedisConfigGroupList
`configGroupName`	String	Optional	Filter by config group name Check through getCloudRedisConfigGroupList
`cloudRedisImageProductCode`	String	Optional	Filter by Cloud Redis image product code applicable for the config group version to view Check through getCloudRedisImageProductList
`cloudRedisModeCode`	String	Optional	Cloud DB for Redis configurationFilter by Cloud DB for Redis configuration type `CLUSTER` \| `SIMPLE` Check through getCloudRedisInstanceList
`responseFormatType`	String	Optional	Format of the response result `xml` (default) \| `json`

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.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}'

Response

The following describes the response format.

Response body

See ConfigGroupList 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 following is a sample response.

If 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"
    }
}

If responseFormatType=xml (default)

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

Was this article helpful?

What's Next

getCloudRedisImageProductList

Table of contents

Request
Response