deleteCloudCacheConfigGroup

Prev Next

Available in VPC

Delete a Cloud DB for Cache config group.

Caution

You can't delete a config group if a configured Redis service exists in the config group.
If you want to delete it, then remove all settings for the configured Redis service and try again.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET, POST /deleteCloudRedisConfigGroup

Request headers

For information about the headers common to all Cloud DB for Cache APIs, see Cloud DB for Cache request headers.

Request parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code of the Cloud DB for Cache config group to delete
  • Check through getRegionList.
  • First Region of the getRegionList query result (default)
configGroupNo String Required Config group number
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/deleteCloudRedisConfigGroup
?regionCode=KR
&configGroupNo=***9'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section 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 response example is as follows:

  • If responseFormatType=json

    {
        "deleteCloudRedisConfigGroupResponse": {
            "totalRows": 1,
            "cloudRedisConfigGroupList": [
                {
                    "configGroupNo": "***9",
                    "configGroupName": "test-***-config",
                    "configGroupDescription": "decription",
                    "configGroupStatusName": "deleting",
                    "configGroupStatus": {
                        "code": "DELETING",
                        "codeName": "CONFIG GROUP Deleting State"
                    },
                    "cloudRedisVersion": "7.0.15-cluster",
                    "createDate": "2024-07-01T16:36:38+0900",
                    "modifyDate": "2024-07-02T08:45:55+0900"
                }
            ],
            "requestId": "94393e32-****-****-****-0ee9285a58b7",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • If responseFormatType=xml (default)

    <?xml version="1.0" encoding="UTF-8"?>
    <deleteCloudRedisConfigGroupResponse>
        <requestId>94393e32-****-****-****-0ee9285a58b7</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudRedisConfigGroupList>
            <cloudRedisConfigGroup>
                <configGroupNo>***9</configGroupNo>
                <configGroupName>test-***-config</configGroupName>
                <configGroupDescription>decription</configGroupDescription>
                <configGroupStatusName>deleting</configGroupStatusName>
                <configGroupStatus>
                    <code>DELETING</code>
                    <codeName>CONFIG GROUP Deleting State</codeName>
                </configGroupStatus>
                <cloudRedisVersion>7.0.15-cluster</cloudRedisVersion>
                <createDate>2024-07-01T16:36:38+0900</createDate>
                <modifyDate>2024-07-02T08:45:55+0900</modifyDate>
            </cloudRedisConfigGroup>
        </cloudRedisConfigGroupList>
    </deleteCloudRedisConfigGroupResponse>