createCloudRedisConfigGroup

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Create a Cloud DB for Redis config group.
With config groups, you can efficiently manage created Redis servers by grouping them and specifying the same settings for the servers in the group.

Request

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

Method	URI
GET, POST	/createCloudRedisConfigGroup

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 instance on which to create config groups Check through getRegionList First Region of the `getRegionList` query result (default)
`cloudRedisVersion`	String	Required	Version of the config group to create and configuration information for Cloud DB for Redis `4.0.14-cluster` \| `4.0.14-simple` \| `5.0.14-cluster` \| `5.0.14-simple` \| `7.0.13-cluster` \| `7.0.13-simple` \| `7.0.15-cluster` \| `7.0.15-simple` The configuration information in the config group and the type (Cluster/Simple) of the Redis server must match to create a Redis cluster
`configGroupName`	String	Required	Config group service name to create 3 to 15 characters, including lowercase English letters, numbers, and the special character "-", and must begin with an English letter and end with an English letter or number
`configGroupDescription`	String	Optional	Description for the config group to create 0 - 255 characters
`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/createCloudRedisConfigGroup
?regionCode=KR
&cloudRedisVersion=7.0.15-cluster
&configGroupName=test-***-config
&configGroupDescription=decription'
--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

{
    "createCloudRedisConfigGroupResponse": {
        "totalRows": 1,
        "cloudRedisConfigGroupList": [
            {
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "configGroupDescription": "decription",
                "configGroupStatusName": "settingUp",
                "configGroupStatus": {
                    "code": "SETUP",
                    "codeName": "CONFIG GROUP Setup State"
                },
                "cloudRedisVersion": "7.0.15-cluster",
                "createDate": "2024-07-01T16:36:38+0900",
                "modifyDate": "2024-07-01T16:36:38+0900"
            }
        ],
        "requestId": "1af809fc-****-****-****-3ca2a105b758",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

If responseFormatType=xml (default)

<?xml version="1.0" encoding="UTF-8"?>
<createCloudRedisConfigGroupResponse>
    <requestId>1af809fc-****-****-****-3ca2a105b758</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisConfigGroupList>
        <cloudRedisConfigGroup>
            <configGroupNo>***9</configGroupNo>
            <configGroupName>test-***-config</configGroupName>
            <configGroupDescription>decription</configGroupDescription>
            <configGroupStatusName>settingUp</configGroupStatusName>
            <configGroupStatus>
                <code>SETUP</code>
                <codeName>CONFIG GROUP Setup State</codeName>
            </configGroupStatus>
            <cloudRedisVersion>7.0.15-cluster</cloudRedisVersion>
            <createDate>2024-07-01T16:36:38+0900</createDate>
            <modifyDate>2024-07-01T16:36:38+0900</modifyDate>
        </cloudRedisConfigGroup>
    </cloudRedisConfigGroupList>
</createCloudRedisConfigGroupResponse>

Was this article helpful?

What's Next

createCloudRedisInstance

Table of contents

Request
Response